Skip to content
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

Closed
wants to merge 4 commits into from

Conversation

mschmidt87
Copy link
Member

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

@mschmidt87 mschmidt87 marked this pull request as draft April 5, 2021 12:24
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
@jakobj
Copy link
Member

jakobj commented Apr 7, 2021

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.

@jakobj jakobj added this to the 0.3.0 milestone Apr 7, 2021
@jakobj jakobj linked an issue Apr 7, 2021 that may be closed by this pull request
@jakobj jakobj self-requested a review April 7, 2021 19:46
@mschmidt87
Copy link
Member Author

There are currently two problems:

  • Generating the docs on my local machine gets stuck in one example (multi_genome) for the 0.2.0 release version. I don't understand why because running the example manually works seamlessly. I suspect that it has something to do with the multiprocessing in combination with subprocesses used by sphinx-multiversion, but I don't know how to test it or fix it.
  • I don't know how to fix that issue in the CI. I had opened an issue about this (back when we were still using Travis) and received a reply from another user which I implemented but it doesn't help: Documentation build fails on Travis CI Holzhaus/sphinx-multiversion#57

So, I am leaning towards migrating the docs to readthedocs, which offers multiversion and does all the work for us.

@jakobj
Copy link
Member

jakobj commented Apr 13, 2021

There are currently two problems:

* Generating the docs on my local machine gets stuck in one example (multi_genome) for the 0.2.0 release version. I don't understand why because running the example manually works seamlessly. I suspect that it has something to do with the multiprocessing in combination with subprocesses used by sphinx-multiversion, but I don't know how to test it or fix it.

hmm, n_processes is 1 in the example, so multiprocessing shouldn't be used. to tackle such issues, would it be worthwhile to implement a debug switch that disables multiprocessing across the whole library?

* I don't know how to fix that issue in the CI. I had opened an issue about this (back when we were still using Travis) and received a reply from another user which I implemented but it doesn't help: [Holzhaus/sphinx-multiversion#57](https://github.com/Holzhaus/sphinx-multiversion/issues/57)

ouch, i have no idea, sorry. can you reproduce the issue locally or does it only happen in CI?

So, I am leaning towards migrating the docs to readthedocs, which offers multiversion and does all the work for us.

you have my blessing :)

@mschmidt87
Copy link
Member Author

There are currently two problems:

* Generating the docs on my local machine gets stuck in one example (multi_genome) for the 0.2.0 release version. I don't understand why because running the example manually works seamlessly. I suspect that it has something to do with the multiprocessing in combination with subprocesses used by sphinx-multiversion, but I don't know how to test it or fix it.

hmm, n_processes is 1 in the example, so multiprocessing shouldn't be used. to tackle such issues, would it be worthwhile to implement a debug switch that disables multiprocessing across the whole library?

This does not happen in CI, though, so seems to have something to do with my local system.

* I don't know how to fix that issue in the CI. I had opened an issue about this (back when we were still using Travis) and received a reply from another user which I implemented but it doesn't help: [Holzhaus/sphinx-multiversion#57](https://github.com/Holzhaus/sphinx-multiversion/issues/57)

ouch, i have no idea, sorry. can you reproduce the issue locally or does it only happen in CI?
Only in CI, so basically impossible to debug.

So, I am leaning towards migrating the docs to readthedocs, which offers multiversion and does all the work for us.

you have my blessing :)

Yep, I will close this PR and open another one to migrate to readthedocs.

@mschmidt87 mschmidt87 closed this Apr 14, 2021
@mschmidt87 mschmidt87 deleted the docs/multi_version branch April 21, 2021 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multi-version documentation
2 participants