Skip to content

Commit

Permalink
Fix add_module_names usage in conf.py (Qiskit/qiskit-metapackage#1786)
Browse files Browse the repository at this point in the history
As part of the the recently merged Qiskit/qiskit-metapackage#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.
  • Loading branch information
mtreinish authored Jul 28, 2023
1 parent f3d3be9 commit 08b79be
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
pygments_style = "colorful"

# Whether module names are included in crossrefs of functions, classes, etc.
add_module_names = False
add_module_names = True

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

# Plot directive configuration
# ----------------------------
Expand Down

0 comments on commit 08b79be

Please sign in to comment.