Implement :no-index-entry: for autodoc
#12233
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Please could you remove the configuration variable for now? I'm not convinced of the use, and we have a dizzying array of options already. A |
|
no problem. can it remain as part of |
# Conflicts: # CHANGES.rst # doc/usage/extensions/autodoc.rst # sphinx/directives/__init__.py # sphinx/domains/c/__init__.py # sphinx/domains/cpp/__init__.py # sphinx/domains/python/__init__.py # sphinx/ext/autodoc/directive.py
# Conflicts: # CHANGES.rst # sphinx/domains/python/__init__.py # tests/test_domains/test_domain_py.py
AA-Turner
changed the title
no_index_entry config variable, and implement :no-index-entry: for autodoc :):no-index-entry: for autodoc
|
Thanks for tidying this up for me! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subject: Support use of
:no-index-entry:at a project-level and within autodoc.Feature or Bugfix
Purpose
I love the
indexdirective, and I use it often when I am writing narrative docs. When I also have API docs, though, it quickly becomes very busy for the purpose of having an explicit, manual index: all the symbols from various objects end up there, and the manual index terms are very difficult to parse out.no-indexremoves cross-references entirely, butno-index-entrydoes exactly what I need it to do! Unfortunately it is not supported byautodoccurrently. It also is often not supported by downstream packages likesphinx-click, etc.This PR
:no-index-entry:option to the autodoc directivesAdds ano_index_entry(defaultFalse) to global configuration optionsDetail
In local testing, it seems to work as expected! Please let me know if additional documentation or testing is needed here, or if there is a better way of doing this.