-
Notifications
You must be signed in to change notification settings - Fork 22
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
Fix documentation build on ReadTheDocs #116
Comments
roskakori
changed the title
Fix documentation build on readthedocs
Fix documentation build on ReadTheDocs
Jun 27, 2023
roskakori
added a commit
that referenced
this issue
Jun 27, 2023
roskakori
added a commit
that referenced
this issue
Jun 27, 2023
This enables the local build, the CI build and the ReadTheDocs build to have the same potential dependency conflicts and consequently detect the early on.
roskakori
added a commit
that referenced
this issue
Jun 27, 2023
Sadly it seems very hard to locally mix a docs/requirements.txt with poetry when building both locally and on ReadTheDocs. So for the time being, they use different build methods. But unlike before, the Sphinx version in poetry.toml and docs/requirements.txt are the same. This should allow to detect possible documentation build error before they make it to ReadTheDocs.
roskakori
added a commit
that referenced
this issue
Jun 27, 2023
Rationale: The maintenance of sphinx_rtd_theme is sub par. For details see <readthedocs/sphinx_rtd_theme#1463>.
roskakori
added a commit
that referenced
this issue
Jun 27, 2023
…-readthedocs #116 Fix documentation build on ReadTheDocs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Currently the build on ReadTheDocs fails with the following error:
This has already been reported two months ago but not addressed yet: readthedocs/sphinx_rtd_theme#1463. A comment at this issue suggests to switch to the furo theme.
Expected state:
Not sure why it doesn't already. It does build the documentation usingSpank me. CI did not build the docs.make
, which if I understand correctly creates its own virtualenv, which should fail because of the dependency conflict above. However, for some reason however it does not.The text was updated successfully, but these errors were encountered: