Napoleon custom section alias #12478
Unanswered
fabcor-maxiv
asked this question in
Q&A
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
If we have the following in
conf.py
:and the following in some module:
should we expect the section title to be rendered as "Hardware Properties" or as "HwProps"?
We would expect the former (i.e. the alias to be resolved and the original title to be used), but we seem to be getting the latter.
Our reasoning is that
Args
is documented as an alias ofParameters
, and indeed if we add anArgs
section in the docstring, this section gets rendered as "Parameters" (not as "Args").Beta Was this translation helpful? Give feedback.
All reactions