Skip to content

Install development dependencies for Read the Docs dev builds - #73

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

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

Conversation

@PierreRaybaut

Copy link
Copy Markdown
Contributor

Summary

Read the Docs installs dependencies from PyPI only. Branch and pull request documentation builds therefore fail as soon as PlotPy requires a guidata or PythonQwt version that is not released yet. This happened on every DataLab-Platform/SigimaX pull request of the last development cycle (fixed by DataLab-Platform/SigimaX#14).

Changes

  • New scripts/rtd_install_dev_deps.py, run as a build.jobs.pre_install step (after the existing in-place extension build), mirroring test_pyqt5.yml:
    • Tag builds and master (stable / latest): unchanged, dependencies come from PyPI.
    • Other branches and pull requests: guidata is installed from develop and PythonQwt from master. RTD's regular install step then keeps them, as they satisfy the requirements.
  • The same script is used by DataLab-Platform/Sigima and DataLab-Platform/SigimaX; only its project-specific settings block differs.

Validation

  • Branch selection checked for a tag, the default branch, develop, a pull request and a pull request from a fork.
  • Read the Docs install sequence reproduced on Ubuntu 22.04 (same image as RTD) in a clean virtualenv: the development dependencies are installed from GitHub, then RTD's 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 plotpy: enable Build pull requests for this project to get the documentation check on pull requests.

… builds

Read the Docs installs dependencies from PyPI only, so documentation builds of
development branches and pull requests fail as soon as PlotPy requires a
guidata or PythonQwt version that is not released yet.

Add a pre_install step mirroring the GitHub Actions test workflows: for branch
and pull request builds, guidata is installed from its develop branch and
PythonQwt from master. Tag builds and the master branch keep using PyPI
releases.

The script is shared with Sigima and SigimaX; only its project-specific
settings differ.

Assisted-by: Claude Opus 5.5
@PierreRaybaut PierreRaybaut reopened this Oct 23, 2026
@PierreRaybaut
PierreRaybaut merged commit bf1f636 into develop Oct 23, 2026
5 of 7 checks passed
@PierreRaybaut
PierreRaybaut deleted the ci/rtd-dev-deps branch October 24, 2026 13:19
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