DOC: Modify Templates #17691
DOC: Modify Templates #17691
Conversation
There was a problem hiding this comment.
@takanori-pskq in your opinion is this or PR gh-17515 preferable?
Co-authored-by: Matti Picus <matti.picus@gmail.com>
Co-authored-by: Matti Picus <matti.picus@gmail.com>
Co-authored-by: Matti Picus <matti.picus@gmail.com>
Co-authored-by: Matti Picus <matti.picus@gmail.com>
|
I think this PR (#17691 ) is a better way. |
|
Thanks @takanori-pskq |
|
Can you give a link to a description of this |
|
Ah, I see it's at least implemented here: https://github.com/sphinx-doc/sphinx/blob/master/sphinx/ext/autodoc/__init__.py#L54-L62 introduced in sphinx-doc/sphinx@dafb55a. I get the feeling this is a sphinx implementation detail - that's not a problem, but if it blows up in our face hopefully someone will find this comment. |
|
I found this syntax in the document https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html .
in the "Options and advanced usage" in the "Directive" section. |
For the comparison with #17515 . The differences are:
:template:option). This also means that we don't have to care the type of the object (function,attribute, etc.)numpy.ma(see DOC: Create templates formadocuments #17515 (comment) for the effect)I think this is better than #17515, but I'm not sure.