Skip to content

Commit f4d952b

Browse files
committed
Fix add_module_names usage in conf.py
As part of the the recently merged Qiskit#1784 we tried to update the add_module_names flag to be true to correspond to some organizational changes made to the docs in the release. However, a typo in that PR resulted in not actually setting the flag correctly. It also neglected that it was already set in the configuration file above to False. This commit removes the duplicate typo entry and just updates the existing entry to be the new setting.
1 parent 36da55a commit f4d952b

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

docs/conf.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@
119119
pygments_style = "colorful"
120120

121121
# Whether module names are included in crossrefs of functions, classes, etc.
122-
add_module_names = False
122+
add_module_names = True
123123

124124
# A list of prefixes that are ignored for sorting the Python module index
125125
# (e.g., if this is set to ['foo.'], then foo.bar is shown under B, not F).
@@ -185,7 +185,6 @@
185185
# Only add type hints from signature to description body if the parameter has documentation. The
186186
# return type is always added to the description (if in the signature).
187187
autodoc_typehints_description_target = "documented_params"
188-
add_module_name = True
189188

190189
# Plot directive configuration
191190
# ----------------------------

0 commit comments

Comments
 (0)