From 0a6e692ec0c4402a31e1de1545e76abac6b70a7f Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Wed, 8 May 2024 07:08:22 -0400 Subject: [PATCH] docs: use sphinx-lint --- doc/changes.rst | 8 ++++---- doc/requirements.in | 1 + doc/requirements.pip | 12 +++++++++--- tox.ini | 1 + 4 files changed, 15 insertions(+), 7 deletions(-) diff --git a/doc/changes.rst b/doc/changes.rst index af39d0146..f097ff41a 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -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 diff --git a/doc/requirements.in b/doc/requirements.in index 3b00a4082..124b4a499 100644 --- a/doc/requirements.in +++ b/doc/requirements.in @@ -14,5 +14,6 @@ sphinx sphinx-autobuild sphinx_rtd_theme sphinx-code-tabs +sphinx-lint sphinxcontrib-restbuilder sphinxcontrib-spelling diff --git a/doc/requirements.pip b/doc/requirements.pip index d80cdcefe..f0b3eb1eb 100644 --- a/doc/requirements.pip +++ b/doc/requirements.pip @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/tox.ini b/tox.ini index f236fc407..d189b0465 100644 --- a/tox.ini +++ b/tox.ini @@ -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