diff --git a/dependencies/tox-docs-constraints.in b/dependencies/tox-docs-constraints.in new file mode 100644 index 0000000000..cd6fccd5ff --- /dev/null +++ b/dependencies/tox-docs-constraints.in @@ -0,0 +1,17 @@ +############################################################################### +# # +# This file is only meant to exclude broken dependency versions, not feature # +# dependencies. # +# # +# GUIDELINES: # +# 1. Only list PyPI project versions that need to be excluded using `!=` # +# and `<`. # +# 2. It is allowed to have transitive dependency limitations in this file. # +# 3. Apply bare minimum constraints under narrow conditions, use # +# environment markers if possible. E.g. `; python_version < "3.12"`. # +# 4. Whenever there are no constraints, let the file and this header # +# remain in Git. # +# # +############################################################################### + +docutils < 0.22 # https://github.com/executablebooks/sphinx-tabs/pull/207 diff --git a/dependencies/tox-docs.in b/dependencies/tox-docs.in index 03337ea2bf..930c3714f4 100644 --- a/dependencies/tox-docs.in +++ b/dependencies/tox-docs.in @@ -1,3 +1,4 @@ +-c tox-docs-constraints.in # limits known broken versions -r tests.in # `sphinxcontrib-autodoc` will import all the files Sphinx >= 1.8.2 diff --git a/docs/changelog-fragments.d/811.contrib.rst b/docs/changelog-fragments.d/811.contrib.rst new file mode 100644 index 0000000000..8595b9ce56 --- /dev/null +++ b/docs/changelog-fragments.d/811.contrib.rst @@ -0,0 +1,3 @@ +Documentation building: adjusted :mod:`~sphinx.ext.intersphinx` links to remove +warnings +-- by :user:`mr-c` diff --git a/docs/changelog-fragments.d/811.packaging.rst b/docs/changelog-fragments.d/811.packaging.rst new file mode 100644 index 0000000000..c3ab8d421e --- /dev/null +++ b/docs/changelog-fragments.d/811.packaging.rst @@ -0,0 +1,5 @@ +Constrained the version of docutils to before 0.22 so that the sphinx-tabs plugin +continues to work. Can be reverted once +``__ is merged and a +new release of sphinx-tabs is made +-- by :user:`mr-c`. diff --git a/docs/conf.py b/docs/conf.py index 91ea98e04e..a8c4ecebed 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,15 +80,12 @@ intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), 'python2': ('https://docs.python.org/2', None), - # Ref: https://github.com/cherrypy/cherrypy/issues/1872 - 'cherrypy': ( - 'https://docs.cherrypy.dev/en/latest', - ('https://cherrypy.rtfd.io/en/latest', None), - ), + 'cherrypy': ('https://docs.cherrypy.dev/en/latest', None), 'trustme': ('https://trustme.readthedocs.io/en/latest/', None), 'ddt': ('https://ddt.readthedocs.io/en/latest/', None), 'pyopenssl': ('https://www.pyopenssl.org/en/latest/', None), - 'towncrier': ('https://towncrier.rtfd.io/en/latest', None), + 'towncrier': ('https://towncrier.readthedocs.io/en/latest/', None), + 'sphinx': ('https://www.sphinx-doc.org', None), } linkcheck_ignore = [ diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 6ab6243e0c..06b204518e 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -21,6 +21,7 @@ Fortran hardcoded hostname inclusivity +intersphinx iterable linter linters diff --git a/pyproject.toml b/pyproject.toml index b668f175a5..2634112292 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -77,6 +77,7 @@ docs = [ "sphinx >= 1.8.2", "jaraco.packaging >= 3.2", "sphinx-tabs >= 1.1.0", + "docutils < 0.22", # https://github.com/executablebooks/sphinx-tabs/pull/207 # local "furo",