File tree 5 files changed +11
-14
lines changed
5 files changed +11
-14
lines changed Original file line number Diff line number Diff line change 26
26
cache-dependency-path : ' Doc/requirements.txt'
27
27
- name : ' Install build dependencies'
28
28
run : make -C Doc/ venv
29
- - name : ' Check documentation'
30
- run : make -C Doc/ check
31
29
- name : ' Build HTML documentation'
32
30
run : make -C Doc/ SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html
33
31
- name : ' Upload'
37
35
path : Doc/build/html
38
36
39
37
# This build doesn't use problem matchers or check annotations
40
- # It also does not run 'make check', as sphinx-lint is not installed into the
41
- # environment.
42
38
build_doc_oldest_supported_sphinx :
43
39
name : ' Docs (Oldest Sphinx)'
44
40
runs-on : ubuntu-latest
Original file line number Diff line number Diff line change 5
5
- id : check-yaml
6
6
- id : trailing-whitespace
7
7
types_or : [c, python, rst]
8
+
9
+ - repo : https://github.com/sphinx-contrib/sphinx-lint
10
+ rev : v0.6.8
11
+ hooks :
12
+ - id : sphinx-lint
13
+ args : [--enable=default-role]
14
+ files : ^Doc/|^Misc/NEWS.d/next/
15
+ types : [rst]
Original file line number Diff line number Diff line change @@ -214,11 +214,9 @@ dist:
214
214
rm -r dist/python-$(DISTVERSION)-docs-texinfo
215
215
rm dist/python-$(DISTVERSION)-docs-texinfo.tar
216
216
217
- check :
218
- # Check the docs and NEWS files with sphinx-lint.
219
- # Ignore the tools and venv dirs and check that the default role is not used.
220
- $(SPHINXLINT ) -i tools -i $(VENVDIR ) --enable default-role
221
- $(SPHINXLINT ) --enable default-role ../Misc/NEWS.d/next/
217
+ check : venv
218
+ $(VENVDIR ) /bin/python3 -m pre_commit --version > /dev/null || $(VENVDIR ) /bin/python3 -m pip install pre-commit
219
+ $(VENVDIR ) /bin/python3 -m pre_commit run --all-files
222
220
223
221
serve :
224
222
@echo " The serve target was removed, use htmlview instead (see bpo-36329)"
Original file line number Diff line number Diff line change @@ -23,7 +23,3 @@ sphinxcontrib-serializinghtml<1.2
23
23
24
24
# Direct dependencies of Jinja2 (Jinja is a dependency of Sphinx, see above)
25
25
MarkupSafe<2.2
26
-
27
- # Direct dependencies of sphinx-lint
28
- polib<1.3
29
- regex<2024
Original file line number Diff line number Diff line change @@ -10,7 +10,6 @@ sphinx==4.5.0
10
10
11
11
blurb
12
12
13
- sphinx-lint == 0.6.7
14
13
sphinxext-opengraph >= 0.7.1
15
14
16
15
# The theme used by the documentation is stored separately, so we need
You can’t perform that action at this time.
0 commit comments