summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Smith <smithdc@gmail.com>2023-08-01 21:22:53 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2023-08-03 09:34:45 +0200
commit39c9aa1d85c678451b867004c7d797a6f9313224 (patch)
tree143ad03cb1d876759e45f3fc6219e6d5b5f5a405
parent44f6bb56529ac089017352c8c5803e011f6da493 (diff)
[4.1.x] Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+.
Backport of b3e0170ab546a96930ce3114b0a1a560953c0ff4 from main
-rw-r--r--docs/_ext/djangodocs.py17
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/_ext/djangodocs.py b/docs/_ext/djangodocs.py
index 5e99f9f5e0..5a59b01039 100644
--- a/docs/_ext/djangodocs.py
+++ b/docs/_ext/djangodocs.py
@@ -132,12 +132,23 @@ class DjangoHTMLTranslator(HTMLTranslator):
def visit_desc_parameterlist(self, node):
self.body.append("(") # by default sphinx puts <big> around the "("
- self.first_param = 1
self.optional_param_level = 0
self.param_separator = node.child_text_separator
- self.required_params_left = sum(
+ # Counts 'parameter groups' being either a required parameter, or a set
+ # of contiguous optional ones.
+ required_params = [
isinstance(c, addnodes.desc_parameter) for c in node.children
- )
+ ]
+ # How many required parameters are left.
+ self.required_params_left = sum(required_params)
+ if sphinx_version < (7, 1):
+ self.first_param = 1
+ else:
+ self.is_first_param = True
+ self.params_left_at_level = 0
+ self.param_group_index = 0
+ self.list_is_required_param = required_params
+ self.multi_line_parameter_list = False
def depart_desc_parameterlist(self, node):
self.body.append(")")