Skip to content

Commit fed4251

Browse files
committed
Upgrade sphinx dependency, adjust docs setup to account for api changes
1 parent e39960f commit fed4251

4 files changed

Lines changed: 15 additions & 28 deletions

File tree

doc/source/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,4 +210,6 @@
210210
]
211211

212212
# Example configuration for intersphinx: refer to the Python standard library.
213-
intersphinx_mapping = {'https://docs.python.org/': None}
213+
intersphinx_mapping = {'python': ('https://docs.python.org/', None)}
214+
215+
coverage_statistics_to_report = False

noxfile.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,7 @@ def _detect_python_nox_id() -> str:
5454
print(f'CI job mode; using provided interpreter only; PYTHON_VERSIONS={PYTHON_VERSIONS!r}')
5555

5656
PYTHON_DEFAULT_VERSION = next(
57-
(
58-
version
59-
for version in reversed(PYTHON_VERSIONS)
60-
if not version.lower().startswith('pypy')
61-
),
57+
(version for version in reversed(PYTHON_VERSIONS) if not version.lower().startswith('pypy')),
6258
PYTHON_VERSIONS[-1],
6359
)
6460

@@ -233,8 +229,8 @@ def doc_cover(session):
233229
session.run('cat', report_file, external=True)
234230

235231
with open('build/coverage/python.txt') as fd:
236-
# If there is no undocumented files, the report should have only 2 lines (header)
237-
if sum(1 for _ in fd) != 2:
232+
# If there is no undocumented files, the report should have only 3 lines (header)
233+
if sum(1 for _ in fd) != 3:
238234
session.error('sphinx coverage has failed')
239235

240236

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ release = [
7272
]
7373
doc = [
7474
"sadisplay>=0.4.9",
75-
"sphinx>=5.3.0, <6",
75+
"sphinx>=7.4.7, <8",
7676
"sphinx-autobuild>=2021.3.14",
7777
"sphinx-rtd-theme>=2.0.0",
7878
"sphinx-autodoc-typehints>=1.23.0",

0 commit comments

Comments
 (0)