Skip to content

Commit

Permalink
docs: use sphinx-lint
Browse files Browse the repository at this point in the history
  • Loading branch information
nedbat committed May 8, 2024
1 parent a11e0e2 commit 0a6e692
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 7 deletions.
8 changes: 4 additions & 4 deletions doc/changes.rst
Expand Up @@ -845,10 +845,10 @@ Version 4.3.2 — 2017-01-16
would cause a "No data to report" error, as reported in `issue 549`_. This is
now fixed; thanks, Loïc Dachary.

- If-statements can be optimized away during compilation, for example, `if 0:`
or `if __debug__:`. Coverage.py had problems properly understanding these
statements which existed in the source, but not in the compiled bytecode.
This problem, reported in `issue 522`_, is now fixed.
- If-statements can be optimized away during compilation, for example,
``if 0:`` or ``if __debug__:``. Coverage.py had problems properly
understanding these statements which existed in the source, but not in the
compiled bytecode. This problem, reported in `issue 522`_, is now fixed.

- If you specified ``--source`` as a directory, then coverage.py would look for
importable Python files in that directory, and could identify ones that had
Expand Down
1 change: 1 addition & 0 deletions doc/requirements.in
Expand Up @@ -14,5 +14,6 @@ sphinx
sphinx-autobuild
sphinx_rtd_theme
sphinx-code-tabs
sphinx-lint
sphinxcontrib-restbuilder
sphinxcontrib-spelling
12 changes: 9 additions & 3 deletions doc/requirements.pip
Expand Up @@ -12,7 +12,7 @@ anyio==4.3.0
# watchfiles
attrs==23.2.0
# via scriv
babel==2.14.0
babel==2.15.0
# via sphinx
certifi==2024.2.2
# via requests
Expand Down Expand Up @@ -45,7 +45,7 @@ idna==3.7
# requests
imagesize==1.4.1
# via sphinx
jinja2==3.1.3
jinja2==3.1.4
# via
# scriv
# sphinx
Expand All @@ -59,14 +59,18 @@ packaging==24.0
# via sphinx
pbr==6.0.0
# via stevedore
polib==1.2.0
# via sphinx-lint
pyenchant==3.2.2
# via
# -r doc/requirements.in
# sphinxcontrib-spelling
pygments==2.17.2
pygments==2.18.0
# via
# doc8
# sphinx
regex==2024.4.28
# via sphinx-lint
requests==2.31.0
# via
# scriv
Expand All @@ -92,6 +96,8 @@ sphinx-autobuild==2024.4.16
# via -r doc/requirements.in
sphinx-code-tabs==0.5.5
# via -r doc/requirements.in
sphinx-lint==0.9.1
# via -r doc/requirements.in
sphinx-rtd-theme==2.0.0
# via -r doc/requirements.in
sphinxcontrib-applehelp==1.0.8
Expand Down
1 change: 1 addition & 0 deletions tox.ini
Expand Up @@ -76,6 +76,7 @@ commands =
# If this command fails, see the comment at the top of doc/cmd.rst
python -m cogapp -cP --check --verbosity=1 doc/*.rst
doc8 -q --ignore-path 'doc/_*' doc CHANGES.rst README.rst
sphinx-lint doc CHANGES.rst README.rst
sphinx-build -b html -aEnqW doc doc/_build/html
rst2html.py --strict README.rst doc/_build/trash
- sphinx-build -b html -b linkcheck -aEnq doc doc/_build/html
Expand Down

0 comments on commit 0a6e692

Please sign in to comment.