How to host multiple version of a Sphinx based documentation on GitHub?

Question

When using Github pages to host Sphinx documentation, it might be desirable to host multiple versions of the same documentation for different branches or tag of the code. However, both sphinxcontrib-multiversion and sphinxcontrib-versioning are not actively maintained and they do not work with the latest version of Sphinx.

If one does not want to use ReadTheDocs, and want to stick to the Alabaster theme, what would be the right solution ?

Answer 1

For a DIY implementation, you can refer to how I implemented this for the rinohtype documentation. I first implemented this for the Sphinx RTD theme and later switched to Sphinx-Immaterial. Note that both of these themes provide version selectors, which I don't think Alabaster does.

These are the relevant commits:

• GitHub workflow: publish docs to version dir
• GitHub workflow: find docs versions and write to JSON
• HTML docs: populate Versions pane from JSON file
• Docs: configure/create im_versions.json for Sphinx-Immaterial