Skip to content

Commit 998cfcd

Browse files
committed
Merge branch 'master' into autosummary-class
# Conflicts: # CHANGES.rst
2 parents fb9a11e + c7eaf17 commit 998cfcd

File tree

235 files changed

+9052
-6041
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

235 files changed

+9052
-6041
lines changed

.flake8

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

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ contact_links:
55
url: https://stackoverflow.com/questions/tagged/python-sphinx
66
about: For Q&A purpose, please use Stackoverflow with the tag python-sphinx
77
- name: Discussion
8-
url: https://groups.google.com/forum/#!forum/sphinx-users
9-
about: For general discussion, please use sphinx-users mailing list.
8+
url: https://github.com/sphinx-doc/sphinx/discussions
9+
about: For general discussion, please use GitHub Discussions.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,33 @@
1-
Subject: <short purpose of this pull request>
1+
<!--
2+
Thank you for creating this pull request and for spending time to help Sphinx!
3+
Our contributors' guide can be found online: https://www.sphinx-doc.org/en/master/internals/contributing.html
4+
Ask any questions at https://github.com/sphinx-doc/sphinx/discussions
5+
-->
26

3-
### Feature or Bugfix
4-
<!-- please choose -->
5-
- Feature
6-
- Bugfix
7-
- Refactoring
87

9-
### Purpose
10-
- <long purpose of this pull request>
11-
- <Environment if this PR depends on>
8+
## Purpose
129

13-
### Detail
14-
- <feature1 or bug1>
15-
- <feature2 or bug2>
10+
<!--
11+
A description of the purpose of this pull request.
12+
Ensure that all relevant information is included for reviewers,
13+
including any environment-specific details.
1614
17-
### Relates
18-
- <URL or Ticket>
15+
* If you plan to add tests or documentation after opening this PR,
16+
please note it here.
17+
* For user-visible changes, remember to add an entry to CHANGES.rst.
18+
* Please add your name to AUTHORS.rst if you haven't already!
19+
-->
1920

21+
22+
## References
23+
24+
<!--
25+
Please add any relevant links here, especially including any
26+
GitHub issues or Pull Requests that this PR would resolve.
27+
This helps to ensure that reviewers have context from
28+
previous discussions or decisions.
29+
-->
30+
31+
- <...>
32+
- <...>
33+
- <...>

.github/workflows/builddoc.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,10 @@ jobs:
3131
- name: Install graphviz
3232
run: sudo apt-get install --no-install-recommends --yes graphviz
3333
- name: Install uv
34-
run: >
35-
curl --no-progress-meter --location --fail
36-
--proto '=https' --tlsv1.2
37-
"https://astral.sh/uv/install.sh"
38-
| sh
34+
uses: astral-sh/setup-uv@v5
35+
with:
36+
version: latest
37+
enable-cache: false
3938
- name: Install dependencies
4039
run: uv pip install .[docs]
4140
- name: Render the documentation

.github/workflows/create-release.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,10 @@ jobs:
3535
with:
3636
python-version: "3"
3737
- name: Install uv
38-
run: >
39-
curl --no-progress-meter --location --fail
40-
--proto '=https' --tlsv1.2
41-
"https://astral.sh/uv/install.sh"
42-
| sh
38+
uses: astral-sh/setup-uv@v5
39+
with:
40+
version: latest
41+
enable-cache: false
4342

4443
- name: Install build dependencies (pypa/build, twine)
4544
run: |

.github/workflows/lint.yml

Lines changed: 23 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -31,41 +31,17 @@ jobs:
3131
RUFF_VERSION=$(awk -F'[="]' '/\[project\.optional-dependencies\]/ {p=1} /ruff/ {if (p) print $4}' pyproject.toml)
3232
echo "RUFF_VERSION=$RUFF_VERSION" >> $GITHUB_ENV
3333
34-
- name: Install Ruff
35-
run: >
36-
curl --no-progress-meter --location --fail
37-
--proto '=https' --tlsv1.2
38-
--write-out "%{stderr}Downloaded: %{url}\n"
39-
"https://astral.sh/ruff/$RUFF_VERSION/install.sh"
40-
| sh
34+
- name: Install Ruff ${{ env.RUFF_VERSION }}
35+
uses: astral-sh/ruff-action@v3
36+
with:
37+
args: --version
38+
version: ${{ env.RUFF_VERSION }}
4139

4240
- name: Lint with Ruff
43-
run: ruff check . --output-format github
41+
run: ruff check --output-format=github
4442

4543
- name: Format with Ruff
46-
run: ruff format . --diff
47-
48-
flake8:
49-
runs-on: ubuntu-latest
50-
51-
steps:
52-
- uses: actions/checkout@v4
53-
with:
54-
persist-credentials: false
55-
- name: Set up Python
56-
uses: actions/setup-python@v5
57-
with:
58-
python-version: "3"
59-
- name: Install uv
60-
run: >
61-
curl --no-progress-meter --location --fail
62-
--proto '=https' --tlsv1.2
63-
"https://astral.sh/uv/install.sh"
64-
| sh
65-
- name: Install dependencies
66-
run: uv pip install --upgrade "flake8>=6.0"
67-
- name: Lint with flake8
68-
run: flake8 .
44+
run: ruff format --diff
6945

7046
mypy:
7147
runs-on: ubuntu-latest
@@ -79,11 +55,10 @@ jobs:
7955
with:
8056
python-version: "3"
8157
- name: Install uv
82-
run: >
83-
curl --no-progress-meter --location --fail
84-
--proto '=https' --tlsv1.2
85-
"https://astral.sh/uv/install.sh"
86-
| sh
58+
uses: astral-sh/setup-uv@v5
59+
with:
60+
version: latest
61+
enable-cache: false
8762
- name: Install dependencies
8863
run: uv pip install ".[lint,test]"
8964
- name: Type check with mypy
@@ -101,11 +76,10 @@ jobs:
10176
with:
10277
python-version: "3"
10378
- name: Install uv
104-
run: >
105-
curl --no-progress-meter --location --fail
106-
--proto '=https' --tlsv1.2
107-
"https://astral.sh/uv/install.sh"
108-
| sh
79+
uses: astral-sh/setup-uv@v5
80+
with:
81+
version: latest
82+
enable-cache: false
10983
- name: Install dependencies
11084
run: uv pip install ".[lint,test]"
11185
- name: Type check with pyright
@@ -123,11 +97,10 @@ jobs:
12397
with:
12498
python-version: "3"
12599
- name: Install uv
126-
run: >
127-
curl --no-progress-meter --location --fail
128-
--proto '=https' --tlsv1.2
129-
"https://astral.sh/uv/install.sh"
130-
| sh
100+
uses: astral-sh/setup-uv@v5
101+
with:
102+
version: latest
103+
enable-cache: false
131104
- name: Install dependencies
132105
run: uv pip install --upgrade sphinx-lint
133106
- name: Lint documentation with sphinx-lint
@@ -145,11 +118,10 @@ jobs:
145118
with:
146119
python-version: "3"
147120
- name: Install uv
148-
run: >
149-
curl --no-progress-meter --location --fail
150-
--proto '=https' --tlsv1.2
151-
"https://astral.sh/uv/install.sh"
152-
| sh
121+
uses: astral-sh/setup-uv@v5
122+
with:
123+
version: latest
124+
enable-cache: false
153125
- name: Install dependencies
154126
run: uv pip install --upgrade twine build
155127
- name: Lint with twine

.github/workflows/main.yml

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,10 @@ jobs:
5858
- name: Install graphviz
5959
run: sudo apt-get install --no-install-recommends --yes graphviz
6060
- name: Install uv
61-
run: >
62-
curl --no-progress-meter --location --fail
63-
--proto '=https' --tlsv1.2
64-
"https://astral.sh/uv/install.sh"
65-
| sh
61+
uses: astral-sh/setup-uv@v5
62+
with:
63+
version: latest
64+
enable-cache: false
6665
- name: Install dependencies
6766
run: uv pip install .[test]
6867
- name: Install Docutils ${{ matrix.docutils }}
@@ -198,9 +197,10 @@ jobs:
198197
- name: Install graphviz
199198
run: choco install --no-progress graphviz
200199
- name: Install uv
201-
run: >
202-
Invoke-WebRequest -Uri "https://astral.sh/uv/install.ps1"
203-
| Invoke-Expression
200+
uses: astral-sh/setup-uv@v5
201+
with:
202+
version: latest
203+
enable-cache: false
204204
- name: Install dependencies
205205
run: uv pip install .[test]
206206
- name: Test with pytest
@@ -232,11 +232,10 @@ jobs:
232232
- name: Install graphviz
233233
run: sudo apt-get install --no-install-recommends --yes graphviz
234234
- name: Install uv
235-
run: >
236-
curl --no-progress-meter --location --fail
237-
--proto '=https' --tlsv1.2
238-
"https://astral.sh/uv/install.sh"
239-
| sh
235+
uses: astral-sh/setup-uv@v5
236+
with:
237+
version: latest
238+
enable-cache: false
240239
- name: Install dependencies
241240
run: uv pip install .[test]
242241
- name: Install Docutils' HEAD
@@ -266,11 +265,10 @@ jobs:
266265
- name: Install graphviz
267266
run: sudo apt-get install --no-install-recommends --yes graphviz
268267
- name: Install uv
269-
run: >
270-
curl --no-progress-meter --location --fail
271-
--proto '=https' --tlsv1.2
272-
"https://astral.sh/uv/install.sh"
273-
| sh
268+
uses: astral-sh/setup-uv@v5
269+
with:
270+
version: latest
271+
enable-cache: false
274272
- name: Install dependencies
275273
run: |
276274
uv pip install .[test] --resolution lowest-direct
@@ -298,11 +296,10 @@ jobs:
298296
- name: Check Python version
299297
run: python --version --version
300298
- name: Install uv
301-
run: >
302-
curl --no-progress-meter --location --fail
303-
--proto '=https' --tlsv1.2
304-
"https://astral.sh/uv/install.sh"
305-
| sh
299+
uses: astral-sh/setup-uv@v5
300+
with:
301+
version: latest
302+
enable-cache: false
306303
- name: Install dependencies
307304
run: uv pip install .[test]
308305
- name: Test with pytest
@@ -330,11 +327,10 @@ jobs:
330327
- name: Install graphviz
331328
run: sudo apt-get install --no-install-recommends --yes graphviz
332329
- name: Install uv
333-
run: >
334-
curl --no-progress-meter --location --fail
335-
--proto '=https' --tlsv1.2
336-
"https://astral.sh/uv/install.sh"
337-
| sh
330+
uses: astral-sh/setup-uv@v5
331+
with:
332+
version: latest
333+
enable-cache: false
338334
- name: Install dependencies
339335
run: uv pip install .[test] pytest-cov
340336
- name: Test with pytest

.github/workflows/transifex.yml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,13 @@ jobs:
2727
mkdir -p /tmp/tx_cli && cd $_
2828
curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash
2929
shell: bash
30+
- name: Install uv
31+
uses: astral-sh/setup-uv@v5
32+
with:
33+
version: latest
34+
enable-cache: false
3035
- name: Install dependencies
31-
run: pip install --upgrade babel jinja2
36+
run: uv pip install --upgrade babel jinja2
3237
- name: Extract translations from source code
3338
run: python utils/babel_runner.py extract
3439
- name: Push translations to transifex.com
@@ -58,8 +63,13 @@ jobs:
5863
mkdir -p /tmp/tx_cli && cd $_
5964
curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash
6065
shell: bash
66+
- name: Install uv
67+
uses: astral-sh/setup-uv@v5
68+
with:
69+
version: latest
70+
enable-cache: false
6171
- name: Install dependencies
62-
run: pip install --upgrade babel jinja2
72+
run: uv pip install --upgrade babel jinja2
6373
- name: Extract translations from source code
6474
run: python utils/babel_runner.py extract
6575
- name: Pull translations from transifex.com

0 commit comments

Comments
 (0)