diff options
| author | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-03-20 16:16:14 +0100 |
|---|---|---|
| committer | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-04-12 19:05:58 +0200 |
| commit | 3c9a74cb0b9e5ca90adfb1ee55b2262717fae223 (patch) | |
| tree | b63766501a1482fa8e34c079e66e8d7385cc9841 /doc/extdev | |
| parent | 14f7d243bd9509d0dab9cace0d9a18fe34b58b92 (diff) | |
| download | sphinx-git-3c9a74cb0b9e5ca90adfb1ee55b2262717fae223.tar.gz | |
Decl styling, docs and restructuring
Diffstat (limited to 'doc/extdev')
| -rw-r--r-- | doc/extdev/nodes.rst | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/doc/extdev/nodes.rst b/doc/extdev/nodes.rst index 3976de4c7..d327e1cb0 100644 --- a/doc/extdev/nodes.rst +++ b/doc/extdev/nodes.rst @@ -8,18 +8,31 @@ Doctree node classes added by Sphinx Nodes for domain-specific object descriptions --------------------------------------------- +Top-level nodes +............... + +These nodes form the top-most levels of object descriptions. + .. autoclass:: desc .. autoclass:: desc_signature .. autoclass:: desc_signature_line +.. autoclass:: desc_content + +Nodes for high-level structure in signatures +............................................ + +These nodes occur in in non-multiline :py:class:`desc_signature` nodes +and in :py:class:`desc_signature_line` nodes. + +.. autoclass:: desc_name .. autoclass:: desc_addname + .. autoclass:: desc_type .. autoclass:: desc_returns -.. autoclass:: desc_name .. autoclass:: desc_parameterlist .. autoclass:: desc_parameter .. autoclass:: desc_optional .. autoclass:: desc_annotation -.. autoclass:: desc_content New admonition-like constructs ------------------------------ |