Skip to content

fix: Correct Read The Docs build failures #115

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

Merged

Conversation

alexbenedicto
Copy link
Contributor

@alexbenedicto alexbenedicto commented Jul 24, 2025

Closes #114

This PR aims to correct the failures in the latest Read The Docs builds.
Specific packages when installing docs/requirements.txt caused conflicts because the python version used is 3.10.

The first solution was to upgrade to python 3.11 but this would not respect the supported versions 3.10 to 3.12 in the repository.
The second solution now applied in this PR is to restrict the version of specific packages.

PS:

  1. xmlschema was added for geos-xml-viewer documentation.
  2. A minor cleanup of autodoc_mock_imports was also added but would not have an impact on the resolution of the issue.
  3. doc-test.yml updated to correctly catch future issues.

The first build that failed was after modifying these packages in the following commit de62e29 (see image):

image

Copy link
Contributor

@paloma-martinez paloma-martinez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the fix !
Do you have an idea of what we could add to the CI to prevent this kind of problem ? It seems a lot of PR CI docs checks were valid while the actual buildings of the doc failed..

@alexbenedicto
Copy link
Contributor Author

@paloma-martinez I updated the doc-test.yml to be matching the .readthedocs.yaml build so the CI should fail correctly now if the same issue occurs.

@alexbenedicto alexbenedicto merged commit 74b80c9 into main Jul 25, 2025
43 checks passed
@alexbenedicto alexbenedicto deleted the benedicto/fix/correct_read_the_docs_build_failures branch July 25, 2025 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fail to build documentation in Read The Docs
3 participants