How to host Sphinx documentation on GitHub Pages?

Solution 1:

Since you pointed out the repo you were looking at, it is possible now to tell how that author makes everything working.

The actual doc generation/deployment workflow is in CircleCI config, https://github.com/amueller/dabl/blob/main/.circleci/config.yml

It simply does the following,

  1. Use build_doc.sh to generate HTML pages and other artifacts.
  2. Use push_doc.sh to copy all artifacts to a GitHub Pages enabled repo, https://github.com/amueller/amueller.github.io

So like I commented, this author only hosts HTML pages and other artifacts generated by Sphinx (as that's what GitHub Pages desires), but not reStructuredText source files.