Skip to content

Commit 7ff8f8f

Browse files
filmorfilmor
committed
Move documentation deps to pyproject.toml
1 parent 36c6f72 commit 7ff8f8f

4 files changed

Lines changed: 881 additions & 307 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,29 @@ jobs:
77
runs-on: ubuntu-latest
88
steps:
99
- uses: actions/checkout@v6
10+
- name: Set up Python
11+
uses: astral-sh/setup-uv@v7
12+
with:
13+
python-version: "3.12"
14+
cache-python: true
15+
activate-environment: true
16+
enable-cache: true
17+
1018
- name: Doxygen Action
1119
uses: mattnotmitt/doxygen-action@1.12.0
1220
with:
1321
working-directory: "doc/"
1422

23+
- name: Synchronize the virtual environment
24+
run: uv sync --managed-python --no-dev --group doc
25+
1526
- name: Build Sphinx documentation
1627
run: |
17-
pip install -r doc/requirements.txt
18-
sphinx-build doc/source/ ./doc/build/html/
28+
uv run sphinx-build doc/source/ ./doc/build/html/
1929
2030
- name: Upload artifact
2131
# Automatically uploads an artifact from the './_site' directory by default
22-
uses: actions/upload-pages-artifact@v4
32+
uses: actions/upload-pages-artifact@v5
2333
with:
2434
path: doc/build/html/
2535

‎doc/requirements.txt‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎pyproject.toml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,13 @@ dev = [
3939
"numpy >=2 ; python_version >= '3.10'",
4040
"numpy <2 ; python_version < '3.10'",
4141
]
42+
doc = [
43+
"sphinx",
44+
"furo>=2025.12.19",
45+
"pygments>=2.20",
46+
"breathe",
47+
"sphinx-csharp @ git+https://github.com/rogerbarton/sphinx-csharp.git",
48+
]
4249

4350
[[project.authors]]
4451
name = "The Contributors of the Python.NET Project"

0 commit comments

Comments
 (0)