Skip to content

Commit b3e0170

Browse files
smithdc1felixxm
authored andcommitted
Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+.
1 parent 9b9c805 commit b3e0170

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/_ext/djangodocs.py

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
from docutils.parsers.rst import Directive
1010
from docutils.statemachine import ViewList
1111
from sphinx import addnodes
12+
from sphinx import version_info as sphinx_version
1213
from sphinx.builders.html import StandaloneHTMLBuilder
1314
from sphinx.directives.code import CodeBlock
1415
from sphinx.domains.std import Cmdoption
@@ -127,12 +128,23 @@ def depart_table(self, node):
127128

128129
def visit_desc_parameterlist(self, node):
129130
self.body.append("(") # by default sphinx puts <big> around the "("
130-
self.first_param = 1
131131
self.optional_param_level = 0
132132
self.param_separator = node.child_text_separator
133-
self.required_params_left = sum(
133+
# Counts 'parameter groups' being either a required parameter, or a set
134+
# of contiguous optional ones.
135+
required_params = [
134136
isinstance(c, addnodes.desc_parameter) for c in node.children
135-
)
137+
]
138+
# How many required parameters are left.
139+
self.required_params_left = sum(required_params)
140+
if sphinx_version < (7, 1):
141+
self.first_param = 1
142+
else:
143+
self.is_first_param = True
144+
self.params_left_at_level = 0
145+
self.param_group_index = 0
146+
self.list_is_required_param = required_params
147+
self.multi_line_parameter_list = False
136148

137149
def depart_desc_parameterlist(self, node):
138150
self.body.append(")")

0 commit comments

Comments
 (0)