sphinx-gh-pages

Want to quickly host your Sphinx documentation on GitHub Pages?

Use the https://github.com/flywire/sphinx-gh-pages/ template button to setup a new repository.

Enable gh-pages in your repository under Settings, Pages, Build and deployment:

• Source: Deploy from a branch
• Branch: gh-pages, /root

Your documentation will be generated at https://[user].github.io/[repository]. Use About settings to Edit repository details and add the Website.

Update your documentation in your repository Main branch by editing docs/index.rst or replace the whole docs folder with an existing Sphinx project. Don't forget to replace this README.rst page.

Enjoy!