Publishing Python Packages

8 Authoring and maintaining documentation

This chapter covers

• Writing prose documentation using reStructuredText
• Automating code documentation collection using sphinx-apidoc and sphinx-autodoc
• Building an HTML documentation site using Sphinx
• Publishing documentation using Read the Docs

At the end of the previous chapter, you achieved the important milestone of publishing your package to the Python Package Index (PyPI) for others to use. The truth is that PyPI already has more than 350,000 packages and will only continue growing. Your work on the functionality, quality, and logistics of packaging has ensured that people can use it, but you’re going to need to put in some more work if you want to ensure they will use it. You already have a captive ...