From 6a4506faac8af1281cb3b569997d4fe23b1cbf90 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Wed, 9 Oct 2024 08:05:24 -0400 Subject: [PATCH] build(docs): upgrade doc dependencies --- doc/api_coveragedata.rst | 2 +- doc/api_exceptions.rst | 2 +- doc/api_module.rst | 1 + doc/api_plugin.rst | 2 +- doc/conf.py | 2 +- doc/requirements.pip | 68 ++++++++++++++++++---------------------- tox.ini | 2 +- 7 files changed, 37 insertions(+), 42 deletions(-) diff --git a/doc/api_coveragedata.rst b/doc/api_coveragedata.rst index 155e4fdab..58aae8811 100644 --- a/doc/api_coveragedata.rst +++ b/doc/api_coveragedata.rst @@ -9,7 +9,7 @@ The CoverageData class .. versionadded:: 4.0 .. module:: coverage - :noindex: + :no-index: .. autoclass:: CoverageData :members: diff --git a/doc/api_exceptions.rst b/doc/api_exceptions.rst index e018a9703..877a4c878 100644 --- a/doc/api_exceptions.rst +++ b/doc/api_exceptions.rst @@ -11,6 +11,6 @@ Coverage exceptions .. autoclass:: CoverageException .. automodule:: coverage.exceptions - :noindex: + :no-index: :members: :exclude-members: CoverageException diff --git a/doc/api_module.rst b/doc/api_module.rst index c3da90fba..6dda6b46d 100644 --- a/doc/api_module.rst +++ b/doc/api_module.rst @@ -7,6 +7,7 @@ coverage module --------------- .. module:: coverage + :no-index: The most important thing in the coverage module is the :class:`coverage.Coverage` class, described in :ref:`api_coverage`, but there diff --git a/doc/api_plugin.rst b/doc/api_plugin.rst index 749553e59..c2e89e306 100644 --- a/doc/api_plugin.rst +++ b/doc/api_plugin.rst @@ -10,7 +10,7 @@ Plug-in classes .. automodule:: coverage.plugin .. module:: coverage - :noindex: + :no-index: The CoveragePlugin class ------------------------ diff --git a/doc/conf.py b/doc/conf.py index 5212d6006..ba86bbaae 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -49,7 +49,7 @@ templates_path = [] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = {'.rst': 'restructuredtext'} # The encoding of source files. #source_encoding = 'utf-8' diff --git a/doc/requirements.pip b/doc/requirements.pip index fcda20985..8c8c68586 100644 --- a/doc/requirements.pip +++ b/doc/requirements.pip @@ -4,29 +4,27 @@ # # make doc_upgrade # -alabaster==0.7.16 +alabaster==1.0.0 # via sphinx -anyio==4.3.0 +anyio==4.6.0 # via # starlette # watchfiles -babel==2.15.0 +babel==2.16.0 # via sphinx -certifi==2024.2.2 +certifi==2024.8.30 # via requests -charset-normalizer==3.3.2 +charset-normalizer==3.4.0 # via requests click==8.1.7 - # via - # click-log - # uvicorn + # via uvicorn cogapp==3.4.1 # via -r doc/requirements.in colorama==0.4.6 # via sphinx-autobuild -doc8==1.1.1 +doc8==1.1.2 # via -r doc/requirements.in -docutils==0.20.1 +docutils==0.21.2 # via # doc8 # restructuredtext-lint @@ -34,22 +32,19 @@ docutils==0.20.1 # sphinx-rtd-theme h11==0.14.0 # via uvicorn -idna==3.7 +idna==3.10 # via # anyio # requests imagesize==1.4.1 # via sphinx jinja2==3.1.4 - # via - # sphinx -markupsafe==2.1.5 + # via sphinx +markupsafe==3.0.1 # via jinja2 -mdurl==0.1.2 - # via markdown-it-py -packaging==24.0 +packaging==24.1 # via sphinx -pbr==6.0.0 +pbr==6.1.0 # via stevedore polib==1.2.0 # via sphinx-lint @@ -61,18 +56,17 @@ pygments==2.18.0 # via # doc8 # sphinx -regex==2024.4.28 +regex==2024.9.11 # via sphinx-lint -requests==2.31.0 - # via - # sphinx +requests==2.32.3 + # via sphinx restructuredtext-lint==1.4.0 # via doc8 sniffio==1.3.1 # via anyio snowballstemmer==2.2.0 # via sphinx -sphinx==7.3.7 +sphinx==8.0.2 # via # -r doc/requirements.in # sphinx-autobuild @@ -81,41 +75,41 @@ sphinx==7.3.7 # sphinxcontrib-jquery # sphinxcontrib-restbuilder # sphinxcontrib-spelling -sphinx-autobuild==2024.4.16 +sphinx-autobuild==2024.10.3 # via -r doc/requirements.in sphinx-code-tabs==0.5.5 # via -r doc/requirements.in -sphinx-lint==0.9.1 +sphinx-lint==1.0.0 # via -r doc/requirements.in -sphinx-rtd-theme==2.0.0 +sphinx-rtd-theme==3.0.0 # via -r doc/requirements.in -sphinxcontrib-applehelp==1.0.8 +sphinxcontrib-applehelp==2.0.0 # via sphinx -sphinxcontrib-devhelp==1.0.6 +sphinxcontrib-devhelp==2.0.0 # via sphinx -sphinxcontrib-htmlhelp==2.0.5 +sphinxcontrib-htmlhelp==2.1.0 # via sphinx sphinxcontrib-jquery==4.1 # via sphinx-rtd-theme sphinxcontrib-jsmath==1.0.1 # via sphinx -sphinxcontrib-qthelp==1.0.7 +sphinxcontrib-qthelp==2.0.0 # via sphinx sphinxcontrib-restbuilder==0.3 # via -r doc/requirements.in -sphinxcontrib-serializinghtml==1.1.10 +sphinxcontrib-serializinghtml==2.0.0 # via sphinx sphinxcontrib-spelling==8.0.0 # via -r doc/requirements.in -starlette==0.37.2 +starlette==0.39.2 # via sphinx-autobuild -stevedore==5.2.0 +stevedore==5.3.0 # via doc8 -urllib3==2.2.1 +urllib3==2.2.3 # via requests -uvicorn==0.29.0 +uvicorn==0.31.0 # via sphinx-autobuild -watchfiles==0.21.0 +watchfiles==0.24.0 # via sphinx-autobuild -websockets==12.0 +websockets==13.1 # via sphinx-autobuild diff --git a/tox.ini b/tox.ini index 4d0c4c746..7bfa8e574 100644 --- a/tox.ini +++ b/tox.ini @@ -78,7 +78,7 @@ commands = 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 + rst2html --verbose --strict README.rst doc/_build/README.html - sphinx-build -b html -b linkcheck -aEnq doc doc/_build/html - sphinx-build -b html -b linkcheck -aEnQW doc doc/_build/html