diff --git a/docs/Makefile b/docs/Makefile --- a/docs/Makefile +++ b/docs/Makefile @@ -29,7 +29,14 @@ apidoc: apidoc-stamp apidoc-stamp: links-stamp - $(SPHINXAPIDOC) --implicit-namespaces $(APIDOC_OPTS) -o $(APIDOC_DIR) $(SWHPKGDIR) $(APIDOC_SWH_EXCLUDES) + $(SPHINXAPIDOC) \ + --implicit-namespaces \ + --templatedir=../swh/docs/templates/ \ + --maxdepth=3 \ + $(APIDOC_OPTS) \ + -o $(APIDOC_DIR) \ + $(SWHPKGDIR) \ + $(APIDOC_SWH_EXCLUDES) touch $@ images-stamp: diff --git a/swh/docs/templates/package.rst_t b/swh/docs/templates/package.rst_t new file mode 100644 --- /dev/null +++ b/swh/docs/templates/package.rst_t @@ -0,0 +1,54 @@ +{# 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 %}