Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions dependencies/tox-docs-constraints.in
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions dependencies/tox-docs.in
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/changelog-fragments.d/811.contrib.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Documentation building: adjusted :mod:`~sphinx.ext.intersphinx` links to remove
"intersphinx inventory has moved" warnings
-- by :user:`mr-c`.
4 changes: 4 additions & 0 deletions docs/changelog-fragments.d/811.packaging.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Constrained the version of :pypi:`docutils` to before 0.22 so that the
:pypi:`sphinx-tabs` plugin continues to work. Can be reverted once
new release (``> 3.4.7``) of :pypi:`sphinx-tabs` is made
-- by :user:`mr-c`.
9 changes: 3 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down
1 change: 1 addition & 0 deletions docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Fortran
hardcoded
hostname
inclusivity
intersphinx
iterable
linter
linters
Expand Down
Loading