Add :subscript: option to :py:{function,method} #13947
Open
+142
−9
Conversation
This file contains hidden or 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
jbms
force-pushed
the
subscript-functions
branch
from
4bcd6d8 to
4eff352
Compare
This can be used to document *subscript methods* and *subscript functions*, like `arr.vindex[1:2, [3, 4, 5]]`.
jbms
force-pushed
the
subscript-functions
branch
from
4eff352 to
1e17df0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This can be used to document subscript methods and subscript functions, like
arr.vindex[1:2, [3, 4, 5]].The sphinx-immaterial theme has monkey patched in support for this functionality but it would be nicer to support it in upstream sphinx.