65856b39fb
- custom _template/autosummary/module.rst to include docs for all module :members" (shows up directly after the summary tables) - module docs should *not* contain autodocs for members, only general descriptions and examples - all files inside api/ are autogenerated whenever sphinx is run (no need to add to the repository, hence excluded in .gitignore)
62 lines
1.1 KiB
ReStructuredText
62 lines
1.1 KiB
ReStructuredText
{{ fullname | escape | underline}}
|
|
|
|
.. automodule:: {{ fullname }}
|
|
:members:
|
|
|
|
{% block attributes %}
|
|
{% if attributes %}
|
|
.. rubric:: Module Attributes
|
|
|
|
.. autosummary::
|
|
{% for item in attributes %}
|
|
{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
{% block functions %}
|
|
{% if functions %}
|
|
.. rubric:: {{ _('Functions') }}
|
|
|
|
.. autosummary::
|
|
{% for item in functions %}
|
|
{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
{% block classes %}
|
|
{% if classes %}
|
|
.. rubric:: {{ _('Classes') }}
|
|
|
|
.. autosummary::
|
|
{% for item in classes %}
|
|
{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
{% block exceptions %}
|
|
{% if exceptions %}
|
|
.. rubric:: {{ _('Exceptions') }}
|
|
|
|
.. autosummary::
|
|
{% for item in exceptions %}
|
|
{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
{% block modules %}
|
|
{% if modules %}
|
|
.. rubric:: Modules
|
|
|
|
.. autosummary::
|
|
:toctree:
|
|
:recursive:
|
|
{% for item in modules %}
|
|
{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|