Publish
Explore how to publish Python code documentation created with Sphinx by building HTML files, configuring GitHub Pages, and optionally hosting on ReadTheDocs. Learn step-by-step how to maintain and share your project documentation effectively.
We'll cover the following...
Documentation
Documentation is important, so it should be easy to create, maintain, and share. We’ve seen how Sphinx makes it easy to create, and how the autodoc extension, by pulling from docstrings, makes it easy to maintain. GitHub and ReadTheDocs make it easy to share. If we’re hosting our project on GitHub, as recommended in this course, then we can make our project’s documentation available on the web. Unfortunately, BitBucket does not currently support this feature. For open-source projects, ReadTheDocs will host our documentation for free, and it can be tied into GitHub to be kept up to date automatically.