Skip to content

Install development Sigima for Read the Docs dev builds - #14

Merged
PierreRaybaut merged 1 commit into
developfrom
ci/rtd-sigima-dev
Oct 23, 2026
Merged

PierreRaybaut merged 1 commit into
developfrom
ci/rtd-sigima-dev

Conversation

@PierreRaybaut

Copy link
Copy Markdown
Contributor

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:

The 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

  • New scripts/rtd_install_sigima.py, run as a build.jobs.pre_install step in .readthedocs.yaml. It mirrors the GitHub Actions logic:
    • Tag builds and main (stable / latest): nothing changes, Sigima comes from PyPI.
    • Other branches and pull requests: Sigima is installed from the GitHub branch with the same name as the SigimaX branch, or from develop if 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 to develop.
  • The regular python.install step (pip install --upgrade-strategy only-if-needed .[doc]) then keeps the pre-installed Sigima, because it already satisfies the requirement.

Validation

Follow-up

Once this is merged, PR #13 needs to be rebased on develop, because RTD reads .readthedocs.yaml from the PR commit.

Note: the stable RTD build fails for an unrelated reason (missing Qt bindings for an old tag, already fixed in df03e92); it will recover with the next release.

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
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.

1 participant