Repository navigation
Install development dependencies for Read the Docs dev builds - #79
Merged
Merged
Conversation
… builds Read the Docs installs dependencies from PyPI only, so documentation builds of development branches and pull requests fail as soon as Sigima requires a guidata version that is not released yet. Add a pre_install step mirroring the GitHub Actions test workflow: for branch and pull request builds, guidata is installed from its develop branch. Tag builds and the main branch keep using PyPI releases. The script is shared with PlotPy and SigimaX; only its project-specific settings differ. Assisted-by: Claude Opus 5.5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Read the Docs installs dependencies from PyPI only. Branch and pull request documentation builds therefore fail as soon as Sigima requires a guidata version that is not released yet. This happened on every SigimaX pull request of the last development cycle (fixed by DataLab-Platform/SigimaX#14).
Changes
scripts/rtd_install_dev_deps.py, run as abuild.jobs.pre_installstep, mirroringtest.yml:main(stable/latest): unchanged, dependencies come from PyPI.developbranch. RTD's regular install step then keeps it, as it satisfies the requirement.Validation
develop, a pull request and a pull request from a fork.pip install --upgrade --upgrade-strategy only-if-needed .[doc]keeps them and succeeds.Read the Docs settings
Pull request builds are not enabled yet for
sigimaandsigima-fr: enable Build pull requests for this project in both projects to get the documentation check on pull requests.