Skip to content

Commit b949917

Browse files
committed
Update to sphinx >= 1.7.0
- Make the fixes suggested here so our docs become compatible with sphinx 1.7.0: sphinx-doc/sphinx#4609 (comment) - Upgrade to sphinx 1.7.0
1 parent a72e471 commit b949917

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

ci/rtd-requirements.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# RTD is currently installing 1.5.3, which has a bug in :lineno-match:
2-
# 1.7.0 hits https://github.com/sphinx-doc/sphinx/issues/4609
3-
sphinx == 1.6.7
2+
sphinx >= 1.7.0
43
sphinx_rtd_theme
54
sphinxcontrib-trio

docs/source/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,13 @@
2828
nitpicky = True
2929
# Except for these ones, which we expect to point to unknown targets:
3030
nitpick_ignore = [
31-
("py:obj", "CapacityLimiter-like object"),
32-
("py:obj", "bytes-like"),
31+
("py:class", "CapacityLimiter-like object"),
32+
("py:class", "bytes-like"),
33+
("py:class", "None"),
3334
# trio.abc is documented at random places scattered throughout the docs
3435
("py:mod", "trio.abc"),
3536
]
37+
autodoc_inherit_docstrings = False
3638

3739
# XX hack the RTD theme until
3840
# https://github.com/rtfd/sphinx_rtd_theme/pull/382

0 commit comments

Comments
 (0)