Repository navigation
Install development Sigima for Read the Docs dev builds - #14
Merged
Merged
Conversation
Read the Docs installs SigimaX dependencies from PyPI only, so documentation builds fail whenever SigimaX requires a Sigima version that is not released yet (e.g. Sigima >= 1.4.0 on PR #13). Add a pre_install step mirroring the GitHub Actions test workflows: for branch and pull request builds, Sigima is installed from the GitHub branch with the same name as the SigimaX branch, falling back to develop. Tag builds and the main branch keep using PyPI releases. 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 builds of SigimaX pull requests fail whenever SigimaX requires a Sigima version that is not yet released on PyPI. RTD installs
sigimax[doc]from PyPI only, so pip cannot resolve the dependency:No matching distribution found for Sigima>=1.3.0(before Sigima 1.3.0 was released)No matching distribution found for Sigima>=1.4.0The GitHub Actions test workflows do not have this problem because they install Sigima from GitHub. Every development cycle therefore leaves the RTD checks red until Sigima is released, which hides real documentation issues.
Changes
scripts/rtd_install_sigima.py, run as abuild.jobs.pre_installstep in.readthedocs.yaml. It mirrors the GitHub Actions logic:main(stable/latest): nothing changes, Sigima comes from PyPI.developif no such branch exists. For PR builds, RTD only exposes the PR number, so the script finds the SigimaX branch whose head matches the built commit (git ls-remote). PRs from forks fall back todevelop.python.installstep (pip install --upgrade-strategy only-if-needed .[doc]) then keeps the pre-installed Sigima, because it already satisfies the requirement.Validation
main,develop, PR Browse and import large HDF5 and NeXus experimental files #13 (→ Sigimafeature/experimental-data-integration), a PR from a fork and a branch with no Sigima counterpart (both →develop).pip install --upgrade --upgrade-strategy only-if-needed .[doc]reportsRequirement already satisfied: Sigima>=1.4.0and succeeds.Follow-up
Once this is merged, PR #13 needs to be rebased on
develop, because RTD reads.readthedocs.yamlfrom the PR commit.Note: the
stableRTD build fails for an unrelated reason (missing Qt bindings for an old tag, already fixed in df03e92); it will recover with the next release.