Closed jnumainville closed 23 hours ago
Are those keys constant?
Like is it always "module_name" or could that be different if it's not a module?
Note we could also write it as actual params rather then a dict, to remove wrapper if it's any easier.
<ParamTable name="name" description="..." params=[{...}] />
module_name
was just an alias I created for info extracted from the desc_addname node as it seems like it would generally be the module
all of the keys are constant otherwise, besides default
in the params objects, which may or may not be there
from what I understand, these nodes, as weirdly structured as they are, do have some consistency. For example, the desc node Contains one or more desc_signature nodes and then a single desc_content node.
I don't think passing params directly would make anything easier on the extension side, but it could be done if it's preferable for the usage side
Fixes #566
This adds a custom sphinx directive (
dhautofunction
) that takes the output of sphinxautofunction
and extracts relevant data. Here is a snippet of the generated item in the area doc (in the doc it is all on one line)