Tips for publishing Python Sphinx with Free Hosting on GitHub Pages

Here’s a new article on the Docs Like Code site, titled “Yes You Can Use GitHub Pages with Python Sphinx.” If you’re familiar with GitHub Pages, you may also know that by default it builds Jekyll sites and uses selectable Jekyll themes. Jekyll itself mostly publishes with Markdown. For fans of Python Sphinx and the ReStructured Text markup language, figuring out how to use Sphinx instead of Jekyll provides more options and flexibility for doc builds.

Here’s an excerpt, and you can read more in the full article.

Make sure you can still build Sphinx locally for reviews
Here’s another pro tip I found while browsing Issues in the Sphinx repository itself. Since you want to keep the source and output separate, but still be able to both publish on GitHub Pages and preview builds locally, you can add an option to your Makefile to do both.

Docs Like Code website

If you want to learn more about Sphinx or Jekyll as a static site generator, check out these tutorials about static site generators in one collection.