File tree 2 files changed +36
-5
lines changed
2 files changed +36
-5
lines changed Original file line number Diff line number Diff line change 83
83
cache-dependency-path : ' setup.py'
84
84
- name : Install dependencies
85
85
run : |
86
- python -m pip install -U pip
87
- python -m pip install sphinx
86
+ pip install tox
88
87
- name : Check links
89
88
run : |
90
- cd doc
91
- make linkcheck
89
+ tox -e linkcheck
Original file line number Diff line number Diff line change @@ -8,8 +8,20 @@ envlist =
8
8
lint,
9
9
# Run pre-commit on all files, including stages that require manual fixes.
10
10
lint-manual,
11
+ # Typecheck using mypy.
12
+ typecheck-mypy,
13
+ # Typecheck using pyright.
14
+ typecheck-pyright,
15
+ # Typecheck using pyright strict.
16
+ typecheck-pyright-strict,
11
17
# Typecheck all files.
12
- typecheck
18
+ typecheck,
19
+ # Build sphinx docs
20
+ doc,
21
+ # Test sphinx docs
22
+ doc-test,
23
+ # Linkcheck sphinx docs
24
+ linkcheck
13
25
14
26
[testenv:test]
15
27
description = run unit tests
@@ -75,3 +87,24 @@ commands =
75
87
{[testenv:typecheck-mypy]commands}
76
88
{[testenv:typecheck-pyright]commands}
77
89
{[testenv:typecheck-pyright-strict]commands}
90
+
91
+ [testenv:doc]
92
+ description = build sphinx docs
93
+ deps =
94
+ sphinx
95
+ commands =
96
+ sphinx-build -E -b html doc ./doc/_build/html
97
+
98
+ [testenv:doc-test]
99
+ description = run sphinx doc tests
100
+ deps =
101
+ {[testenv:doc]deps}
102
+ commands =
103
+ sphinx-build -E -b doctest doc ./doc/_build/doctest
104
+
105
+ [testenv:linkcheck]
106
+ description = check links of sphinx docs
107
+ deps =
108
+ {[testenv:doc]deps}
109
+ commands =
110
+ sphinx-build -E -b linkcheck doc ./doc/_build/linkcheck
You can’t perform that action at this time.
0 commit comments