Differential D5261 Diff 18862 swh/docs/templates/package.rst_t

Changeset View

Standalone View

				{# copy-pasted from sphinx/templates/apidoc/package.rst_t, but makes
				"Subpackages", "Submodules", and "Module Contents" simple text instead
				of headings #}
				{%- 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, "namespace"] \| join(" ") \| e \| heading }}
				{% else %}
				{{- [pkgname, "package"] \| join(" ") \| e \| heading }}
				{% endif %}

				{%- if modulefirst and not is_namespace %}
				{{ automodule(pkgname, automodule_options) }}
				{% endif %}

				{%- if subpackages %}
				Subpackages:

				{{ toctree(subpackages) }}
				{% endif %}

				{%- if submodules %}
				Submodules:

				{% if separatemodules %}
				{{ toctree(submodules) }}
				{% else %}
				{%- for submodule in submodules %}
				{% if show_headings %}
				{{- [submodule, "module"] \| join(" ") \| 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 %}