Skip to content

Commit 51b7d62

Browse files
authored
Merge pull request cherrypy#811 from mr-c/docs_fix_intersphinx_redirect
docs: adjust intersphinx links & fix building docs with Python 3.14
2 parents 662cd9d + abf6ec9 commit 51b7d62

6 files changed

Lines changed: 29 additions & 6 deletions

File tree

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
###############################################################################
2+
# #
3+
# This file is only meant to exclude broken dependency versions, not feature #
4+
# dependencies. #
5+
# #
6+
# GUIDELINES: #
7+
# 1. Only list PyPI project versions that need to be excluded using `!=` #
8+
# and `<`. #
9+
# 2. It is allowed to have transitive dependency limitations in this file. #
10+
# 3. Apply bare minimum constraints under narrow conditions, use #
11+
# environment markers if possible. E.g. `; python_version < "3.12"`. #
12+
# 4. Whenever there are no constraints, let the file and this header #
13+
# remain in Git. #
14+
# #
15+
###############################################################################
16+
17+
docutils < 0.22 # https://github.com/executablebooks/sphinx-tabs/pull/207

dependencies/tox-docs.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
-c tox-docs-constraints.in # limits known broken versions
12
-r tests.in # `sphinxcontrib-autodoc` will import all the files
23

34
Sphinx >= 1.8.2
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Documentation building: adjusted :mod:`~sphinx.ext.intersphinx` links to remove
2+
"intersphinx inventory has moved" warnings
3+
-- by :user:`mr-c`.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Constrained the version of :pypi:`docutils` to before 0.22 so that the
2+
:pypi:`sphinx-tabs` plugin continues to work. Can be reverted once
3+
new release (``> 3.4.7``) of :pypi:`sphinx-tabs` is made
4+
-- by :user:`mr-c`.

docs/conf.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,12 @@
8080
intersphinx_mapping = {
8181
'python': ('https://docs.python.org/3', None),
8282
'python2': ('https://docs.python.org/2', None),
83-
# Ref: https://github.com/cherrypy/cherrypy/issues/1872
84-
'cherrypy': (
85-
'https://docs.cherrypy.dev/en/latest',
86-
('https://cherrypy.rtfd.io/en/latest', None),
87-
),
83+
'cherrypy': ('https://docs.cherrypy.dev/en/latest', None),
8884
'trustme': ('https://trustme.readthedocs.io/en/latest/', None),
8985
'ddt': ('https://ddt.readthedocs.io/en/latest/', None),
9086
'pyopenssl': ('https://www.pyopenssl.org/en/latest/', None),
91-
'towncrier': ('https://towncrier.rtfd.io/en/latest', None),
87+
'towncrier': ('https://towncrier.readthedocs.io/en/latest/', None),
88+
'sphinx': ('https://www.sphinx-doc.org', None),
9289
}
9390

9491
linkcheck_ignore = [

docs/spelling_wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Fortran
2121
hardcoded
2222
hostname
2323
inclusivity
24+
intersphinx
2425
iterable
2526
linter
2627
linters

0 commit comments

Comments
 (0)