Skip to content

Commit e5b3719

Browse files
committed
ci: Check documentation spelling and coverage
1 parent 06237fb commit e5b3719

File tree

4 files changed

+24
-0
lines changed

4 files changed

+24
-0
lines changed

.github/workflows/continuous-integration.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,20 @@ jobs:
4747
env:
4848
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
4949

50+
- name: Check documentation spelling
51+
run: make spelling
52+
working-directory: ./doc
53+
54+
- name: Check documentation coverage
55+
run: make coverage
56+
working-directory: ./doc
57+
58+
- name: Archive documentation coverage results
59+
uses: actions/upload-artifact@v3
60+
with:
61+
name: docs-coverage-report
62+
path: doc/build/coverage/python.txt
63+
5064
- name: Test uninstall
5165
run: python3 -m pip uninstall -y reverse_argparse
5266

doc/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ sphinx-copybutton
66
sphinx-rtd-theme
77
sphinxcontrib-mermaid
88
sphinxcontrib-programoutput
9+
sphinxcontrib-spelling

doc/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
"sphinx_rtd_theme",
3434
"sphinxcontrib.mermaid",
3535
"sphinxcontrib.programoutput",
36+
"sphinxcontrib.spelling",
3637
]
3738
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
3839

doc/source/spelling_wordlist.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
pre
2+
erroring
3+
retryable
4+
programmatically
5+
linters
6+
namespace
7+
argparse
8+
ArgumentGroup

0 commit comments

Comments
 (0)