[WIP] 'hidden' option for domain directives #9671
Closed
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.
Feature or Bugfix
Purpose
Adding feature for #9662, implemented as suggested in #9662 (comment).
Each domain directive that inherits from
ObjectDescription
and keeps theoption_spec
entries in that base class gets an optionhidden
. This will cause the complete document subtree rooted at that declaration to be replaced with an emptyinline
node but where allids
mention in the replaced subtree are put in the new node. As the domains have already run, this effectively hides the declaration, but keeps the anchors in the document.Detail
Each
addnodes.desc
gets a booleanhidden
attribute based on the option, which the post-transform searches for.Instead of duplicating the option I have changed the py, c, cpp, and js domains to extend a copy of the
option_spec
inObjectDescription
.TODO
Assuming this implementation is reasonable the following should be done:
References
Fixes #9662