74 lines
1.4 KiB
ReStructuredText
74 lines
1.4 KiB
ReStructuredText
.. only:: comment
|
|
|
|
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
|
|
|
|
..
|
|
Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.
|
|
..
|
|
{{ fullname | escape | underline}}
|
|
|
|
.. automodule:: {{ fullname }}
|
|
|
|
{% block attributes %}
|
|
{% if attributes %}
|
|
.. rubric:: Module attributes
|
|
|
|
.. autosummary::
|
|
:toctree:
|
|
{% for item in attributes %}
|
|
{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
{% block functions %}
|
|
{% if functions %}
|
|
.. rubric:: {{ _('Functions') }}
|
|
|
|
.. autosummary::
|
|
:toctree:
|
|
:nosignatures:
|
|
{% for item in functions %}
|
|
{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
{% block classes %}
|
|
{% if classes %}
|
|
.. rubric:: {{ _('Classes') }}
|
|
|
|
.. autosummary::
|
|
:toctree:
|
|
:template: custom-class-template.rst
|
|
:nosignatures:
|
|
{% for item in classes %}
|
|
{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
{% block exceptions %}
|
|
{% if exceptions %}
|
|
.. rubric:: {{ _('Exceptions') }}
|
|
|
|
.. autosummary::
|
|
:toctree:
|
|
{% for item in exceptions %}
|
|
{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
{% block modules %}
|
|
{% if modules %}
|
|
.. autosummary::
|
|
:toctree:
|
|
:template: custom-module-template.rst
|
|
:recursive:
|
|
{% for item in modules %}
|
|
{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|