mirror of https://github.com/hpcaitech/ColossalAI
53 lines
1.0 KiB
Plaintext
53 lines
1.0 KiB
Plaintext
|
{%- macro automodule(modname, options) -%}
|
||
|
|
.. automodule:: {{ modname }}
|
||
|
|
{%- for option in options %}
|
||
|
|
:{{ option }}:
|
||
|
|
{%- endfor %}
|
||
|
|
{%- endmacro %}
|
||
|
|
|
||
|
|
{%- macro toctree(docnames) -%}
|
||
|
|
.. toctree::
|
||
|
|
:maxdepth: {{ maxdepth }}
|
||
|
|
{% for docname in docnames %}
|
||
|
|
{{ docname }}
|
||
|
|
{%- endfor %}
|
||
|
|
{%- endmacro %}
|
||
|
|
|
||
|
|
{%- if is_namespace %}
|
||
|
|
{{- pkgname | e | heading }}
|
||
|
|
{% else %}
|
||
|
|
{{- pkgname | e | heading }}
|
||
|
|
{% endif %}
|
||
|
|
|
||
|
|
{%- if is_namespace %}
|
||
|
|
.. py:module:: {{ pkgname }}
|
||
|
|
{% endif %}
|
||
|
|
|
||
|
|
{%- if modulefirst and not is_namespace %}
|
||
|
|
{{ automodule(pkgname, automodule_options) }}
|
||
|
|
{% endif %}
|
||
|
|
|
||
|
|
{%- if subpackages %}
|
||
|
|
{{ toctree(subpackages) }}
|
||
|
|
{% endif %}
|
||
|
|
|
||
|
|
{%- if submodules %}
|
||
|
|
{% if separatemodules %}
|
||
|
|
{{ toctree(submodules) }}
|
||
|
|
{% else %}
|
||
|
|
{%- for submodule in submodules %}
|
||
|
|
{% if show_headings %}
|
||
|
|
{{- submodule | e | heading(2) }}
|
||
|
|
{% endif %}
|
||
|
|
{{ automodule(submodule, automodule_options) }}
|
||
|
|
{% endfor %}
|
||
|
|
{%- endif %}
|
||
|
|
{%- endif %}
|
||
|
|
|
||
|
|
{%- if not modulefirst and not is_namespace %}
|
||
|
|
Module contents
|
||
|
|
---------------
|
||
|
|
|
||
|
|
{{ automodule(pkgname, automodule_options) }}
|
||
|
|
{% endif %}
|