Skip to content

Commit

Permalink
docs: lock sphinx and fix toctree (nextcord#827)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ooliver1 authored and DenverCoder1 committed Oct 23, 2022
1 parent 80dc799 commit 1ce1ab6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,11 @@
# texinfo_no_detailmenu = False


# Remove members from toctree, added by sphinx 5.2
# This *could* be re-enabled once the docs uses multiple pages.
toc_object_entries = False


def setup(app):
if app.config.language == "ja":
app.config.intersphinx_mapping["py"] = ("https://docs.python.org/ja/3", None)
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
extras_require = {
"voice": ["PyNaCl>=1.3.0,<1.5"],
"docs": [
"sphinx>=5.0.1,<6",
"sphinx==5.2.3",
"sphinxcontrib_trio==1.1.2",
"sphinxcontrib-websupport",
"typing_extensions>=4.2.0, <5",
Expand Down

0 comments on commit 1ce1ab6

Please sign in to comment.