From 7e41598b44c68e53db2791170b1abbd8dc6a3c2c Mon Sep 17 00:00:00 2001 From: Olivia Lynn Date: Wed, 3 Dec 2025 00:48:46 -0500 Subject: [PATCH 1/6] Update documentation build workflow for dependencies --- ...if include_docs %}build-documentation.yml{% endif %}.jinja | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja b/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja index 17102b4..b457dd0 100644 --- a/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja +++ b/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja @@ -29,8 +29,8 @@ jobs: run: | sudo apt-get update python -m pip install --upgrade pip - if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi - pip install . + uv pip install --system -e .[dev] + if [ -f requirements.txt ]; then uv pip install --system -r requirements.txt; fi {%- if include_notebooks %} - name: Install notebook requirements run: | From 954382c1965cb7fc3e224aa8a5706e6d925115e3 Mon Sep 17 00:00:00 2001 From: Olivia Lynn Date: Wed, 3 Dec 2025 00:51:30 -0500 Subject: [PATCH 2/6] Remove pip upgrade line --- ...{% if include_docs %}build-documentation.yml{% endif %}.jinja | 1 - 1 file changed, 1 deletion(-) diff --git a/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja b/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja index b457dd0..ac636df 100644 --- a/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja +++ b/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja @@ -28,7 +28,6 @@ jobs: - name: Install dependencies run: | sudo apt-get update - python -m pip install --upgrade pip uv pip install --system -e .[dev] if [ -f requirements.txt ]; then uv pip install --system -r requirements.txt; fi {%- if include_notebooks %} From a0c595a5703110be93d28be6561dbd76ee7ce36a Mon Sep 17 00:00:00 2001 From: Olivia Lynn Date: Wed, 3 Dec 2025 01:00:28 -0500 Subject: [PATCH 3/6] On second thought, just install . and not .[dev] like the testing wf Updated installation command to remove 'dev' dependencies. --- ...% if include_docs %}build-documentation.yml{% endif %}.jinja | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja b/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja index ac636df..a6e336f 100644 --- a/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja +++ b/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja @@ -28,7 +28,7 @@ jobs: - name: Install dependencies run: | sudo apt-get update - uv pip install --system -e .[dev] + uv pip install --system -e . if [ -f requirements.txt ]; then uv pip install --system -r requirements.txt; fi {%- if include_notebooks %} - name: Install notebook requirements From 3f45c0af77cc37674ac03d07d438378ec0a64cf3 Mon Sep 17 00:00:00 2001 From: Olivia Lynn Date: Wed, 3 Dec 2025 01:04:18 -0500 Subject: [PATCH 4/6] Woops, add step that installs uv --- ...% if include_docs %}build-documentation.yml{% endif %}.jinja | 2 ++ 1 file changed, 2 insertions(+) diff --git a/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja b/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja index a6e336f..0f5e23c 100644 --- a/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja +++ b/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja @@ -25,6 +25,8 @@ jobs: uses: actions/setup-python@v5 with: python-version: '{{ py.pref(python_versions) }}' + - name: Install uv + uses: astral-sh/setup-uv@v7 - name: Install dependencies run: | sudo apt-get update From 641a56223b49cdbffb277ca5a16a6c8dbf1a72c7 Mon Sep 17 00:00:00 2001 From: Olivia Lynn Date: Wed, 3 Dec 2025 11:26:25 -0500 Subject: [PATCH 5/6] Add back docs/requirements.txt Add conditional installation of documentation requirements. --- ...{% if include_docs %}build-documentation.yml{% endif %}.jinja | 1 + 1 file changed, 1 insertion(+) diff --git a/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja b/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja index 0f5e23c..4bd2a8b 100644 --- a/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja +++ b/python-project-template/.github/workflows/{% if include_docs %}build-documentation.yml{% endif %}.jinja @@ -31,6 +31,7 @@ jobs: run: | sudo apt-get update uv pip install --system -e . + if [ -f docs/requirements.txt ]; then uv pip install -r docs/requirements.txt; fi if [ -f requirements.txt ]; then uv pip install --system -r requirements.txt; fi {%- if include_notebooks %} - name: Install notebook requirements From be19743040329da8e541f39e75c5b56b81d39305 Mon Sep 17 00:00:00 2001 From: Olivia Lynn Date: Wed, 3 Dec 2025 11:29:15 -0500 Subject: [PATCH 6/6] Add requirements.txt to Read the Docs configuration --- .../{% if include_docs %}.readthedocs.yml{% endif %}.jinja | 1 + 1 file changed, 1 insertion(+) diff --git a/python-project-template/{% if include_docs %}.readthedocs.yml{% endif %}.jinja b/python-project-template/{% if include_docs %}.readthedocs.yml{% endif %}.jinja index 63d9fda..24c69b1 100644 --- a/python-project-template/{% if include_docs %}.readthedocs.yml{% endif %}.jinja +++ b/python-project-template/{% if include_docs %}.readthedocs.yml{% endif %}.jinja @@ -19,5 +19,6 @@ sphinx: python: install: - requirements: docs/requirements.txt + - requirements: requirements.txt - method: pip path: .