Skip to content

Commit 1ce1ab6

Browse files
ooliver1DenverCoder1
authored andcommitted
docs: lock sphinx and fix toctree (nextcord#827)
sphinx-doc/sphinx#10807 decided to add a feature which was enabled by default. This feature however increased the toctree's height and width by a huge amount - a breaking change. This locks sphinx to an exact version to reduce issues like this again.
1 parent 80dc799 commit 1ce1ab6

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/conf.py

+5
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,11 @@
358358
# texinfo_no_detailmenu = False
359359

360360

361+
# Remove members from toctree, added by sphinx 5.2
362+
# This *could* be re-enabled once the docs uses multiple pages.
363+
toc_object_entries = False
364+
365+
361366
def setup(app):
362367
if app.config.language == "ja":
363368
app.config.intersphinx_mapping["py"] = ("https://docs.python.org/ja/3", None)

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
extras_require = {
4545
"voice": ["PyNaCl>=1.3.0,<1.5"],
4646
"docs": [
47-
"sphinx>=5.0.1,<6",
47+
"sphinx==5.2.3",
4848
"sphinxcontrib_trio==1.1.2",
4949
"sphinxcontrib-websupport",
5050
"typing_extensions>=4.2.0, <5",

0 commit comments

Comments
 (0)