roc-toolkit
roc-toolkit copied to clipboard
roc-streaming
Build documentation for multiple releases
We have sphinx documentation and a CI job that automatically generates HTML from it and publishes it on our website on GitHub pages. The job always fetches the latest commit from master and builds docs only for that commit.
Instead, it would be handy to fetch and build documentation for every release (i.e. every git tag starting from v...), plus for develop branch, and allow the user to switch between them when browsing documentation.
Several sphinx extensions exist allowing to do this:
- https://pypi.org/project/sphinx-multiversion/
- https://github.com/sphinx-contrib/sphinxcontrib-versioning
- https://github.com/Smile-SA/sphinx-versions
We should try one of these extensions, enable it in conf.py, install it on our CI build, and modify CI job to find and fetch all tags and develop branch and feed them to the sphinx extension.
Links:
Hello! I have been looking at this project and find it to be really interesting; I look forward to contributing to it. I'd be happy to take this issue up if that's alright.
I have been combing through the build files and travis jobs. If I'm not mistaken, using any of these extensions should replace sphinx_build with its own build command in one of the SConscripts. Is that right or am I missing something?
@rahul-ar Hi, sorry for late reply!
If I'm not mistaken, using any of these extensions should replace sphinx_build with its own build command in one of the SConscripts. Is that right or am I missing something?
I didn't work with them, but from docs it seems yes.