Category: Documentation

An idiot’s guide to Python documentation with Sphinx and ReadTheDocs

   Sam Nicholls    No Comments yet    Documentation, Python

This is the third occasion that I’ve come to set up a Python package’s documentation. It is also the third occasion where I’ve spent many hours and commits trying to work out how I made everything work last time. So for my future sanity and possibly yours, here’s a quick guide on setting up Sphinx-based, ReadTheDocs-hosted Python documentation.