Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

Commit

Permalink
Fix add_module_names usage in conf.py (#1786)
Browse files Browse the repository at this point in the history
<!--
⚠️ If you do not respect this template, your pull request will be
closed.
⚠️ Your pull request title should be short detailed and understandable
for all.
⚠️ Also, please add it in the CHANGELOG file under Unreleased section.
⚠️ If your pull request fixes an open issue, please link to the issue.

✅ I have added the tests to cover my changes.
✅ I have updated the documentation accordingly.
✅ I have read the CONTRIBUTING document.
-->

### Summary

As part of the the recently merged #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.

### Details and comments
  • Loading branch information
mtreinish authored Jul 28, 2023
1 parent 36da55a commit a86eea5
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 a86eea5

Please sign in to comment.