-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implement multiversion building for the docs #298
Conversation
ddf2a77
to
e1290dc
Compare
Use sphinx-multiversion instead of sphinx-build Configure multiversion builds in docs conf file Use RTD theme because it supports multiversion, remove msmb_theme Add sphinx-multiversion to requirements
e1290dc
to
a8fff4f
Compare
great, thanks for working on this! 🚀 hmm, can i somehow look at the doc output? also, there's an error in the build: make: Entering directory '/home/runner/work/hal-cgp/hal-cgp/docs'
sphinx-multiversion -D reset_argv=1 . _build/html
unknown config value 'reset_argv' in override, ignoring
No matching refs found!
make: *** [Makefile:32: html-examples-short] Error 2
make: Leaving directory '/home/runner/work/hal-cgp/hal-cgp/docs'
Error: Process completed with exit code 1. |
8851818
to
36ef22f
Compare
36ef22f
to
5a80744
Compare
There are currently two problems:
So, I am leaning towards migrating the docs to readthedocs, which offers multiversion and does all the work for us. |
hmm,
ouch, i have no idea, sorry. can you reproduce the issue locally or does it only happen in CI?
you have my blessing :) |
This does not happen in CI, though, so seems to have something to do with my local system.
Yep, I will close this PR and open another one to migrate to readthedocs. |
Use sphinx-multiversion instead of sphinx-build
Configure multiversion builds in docs conf file
Use RTD theme because it supports multiversion, remove msmb_theme
Add sphinx-multiversion to requirements