From b4d026a740e5dfe7970d479b40da6d0512985c06 Mon Sep 17 00:00:00 2001 From: Benjamin STOTT Date: Thu, 18 Jun 2026 17:43:47 +0200 Subject: [PATCH 1/2] Fix docs dependency metadata for PyPI --- .github/workflows/docs.yml | 3 ++- docs/requirements.txt | 1 + pyproject.toml | 1 - 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b38f7c0bd..44a940db5 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -34,13 +34,14 @@ jobs: sudo rm -rf /var/lib/apt/lists/* - name: Install documentation dependencies + working-directory: docs run: | df -h python -m pip install --upgrade pip df -h pip install --index-url https://download.pytorch.org/whl/cpu "torch>=2.0.0,<=2.10.0" df -h - pip install -e ".[docs]" + pip install -r requirements.txt df -h - name: Build documentation diff --git a/docs/requirements.txt b/docs/requirements.txt index e21cfc29f..2329429a3 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ -e ..[docs] +sphinx-multiversion-contrib @ git+https://github.com/Quandela/sphinx-multiversion-contrib.git@1.1.1 diff --git a/pyproject.toml b/pyproject.toml index 9a299e1bf..bed3190ca 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -58,7 +58,6 @@ docs = [ "ipykernel", "gitpython", "python-dotenv", - "sphinx-multiversion-contrib @ git+https://github.com/Quandela/sphinx-multiversion-contrib.git@1.1.1", "jinja2==3.0.0", "scikit-learn>=1.7.0", ] From 5d2d97a65c10dc5b44b952c5424df76092c24a9f Mon Sep 17 00:00:00 2001 From: Benjamin STOTT Date: Thu, 18 Jun 2026 18:02:16 +0200 Subject: [PATCH 2/2] Fix docs install paths for VCS dependency --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- README.md | 2 +- docs/requirements.txt | 2 +- requirements-docs-vcs.txt | 1 + requirements-docs.txt | 1 + 5 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 requirements-docs-vcs.txt diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cae5bf475..0d3d224ff 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -84,6 +84,6 @@ mypy . pytest # Build docs -pip install -e .[docs] && make -C docs html +pip install -r requirements-docs.txt && make -C docs html --> diff --git a/README.md b/README.md index 2913a115d..81d3fd73c 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ pip install -e '.[examples]' Build documentation locally: ```bash -pip install -e '.[docs]' +pip install -r requirements-docs.txt cd docs make html # or: make livehtml (if sphinx-autobuild added manually) ``` diff --git a/docs/requirements.txt b/docs/requirements.txt index 2329429a3..c9732596c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,2 @@ -e ..[docs] -sphinx-multiversion-contrib @ git+https://github.com/Quandela/sphinx-multiversion-contrib.git@1.1.1 +-r ../requirements-docs-vcs.txt diff --git a/requirements-docs-vcs.txt b/requirements-docs-vcs.txt new file mode 100644 index 000000000..8db248056 --- /dev/null +++ b/requirements-docs-vcs.txt @@ -0,0 +1 @@ +sphinx-multiversion-contrib @ git+https://github.com/Quandela/sphinx-multiversion-contrib.git@1.1.1 diff --git a/requirements-docs.txt b/requirements-docs.txt index 142b6ca35..998ba2aa1 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1 +1,2 @@ -e .[docs] +-r requirements-docs-vcs.txt