Skip to content

Commit dc4df07

Browse files
committed
Add doc linting
1 parent 45a3e9f commit dc4df07

File tree

3 files changed

+4
-0
lines changed

3 files changed

+4
-0
lines changed

Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ lint:
1717
pylint *.py src tests
1818
pyroma --min 10 .
1919
vulture . --min-confidence 100
20+
$(MAKE) -C docs spelling SPHINXOPTS=$(SPHINXOPTS)
21+
$(MAKE) -C docs linkcheck SPHINXOPTS=$(SPHINXOPTS)
2022
yapf \
2123
--diff \
2224
--recursive \

dev-requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ pylint==2.1.1 # Lint
1919
pyroma==2.4 # Packaging best practices checker
2020
pytest-cov==2.6.0 # Measure code coverage
2121
pytest==3.8.2 # Test runners
22+
sphinxcontrib-spelling==4.2.0
2223
versioneer==0.18
2324
vulture==0.29
2425
yapf==0.24.0 # Automatic formatting for Python

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
'sphinx.ext.autodoc',
1818
'sphinx.ext.intersphinx',
1919
'sphinx.ext.napoleon',
20+
'sphinxcontrib.spelling',
2021
]
2122

2223
templates_path = ['_templates']

0 commit comments

Comments
 (0)