From aa623651a1e92e78cebcf813e634fe48f4db39f9 Mon Sep 17 00:00:00 2001 From: Griatch Date: Mon, 12 Oct 2020 22:11:03 +0200 Subject: [PATCH] Add doc templates from develop --- docs/source/_templates/layout.html | 1 + docs/source/_templates/package.rst_t | 54 ++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 docs/source/_templates/layout.html create mode 100644 docs/source/_templates/package.rst_t diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html new file mode 100644 index 0000000000..efe58c7c39 --- /dev/null +++ b/docs/source/_templates/layout.html @@ -0,0 +1 @@ +{%- extends "!layout.html" %} diff --git a/docs/source/_templates/package.rst_t b/docs/source/_templates/package.rst_t new file mode 100644 index 0000000000..fde7151fc5 --- /dev/null +++ b/docs/source/_templates/package.rst_t @@ -0,0 +1,54 @@ +{%- 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 not modulefirst and not is_namespace %} +Module contents +--------------- + +{{ automodule(pkgname, automodule_options) }} +{% endif %} + +{%- if submodules %} +Modules +------- +{% 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 subpackages %} +Packages/folders +---------------- + +{{ toctree(subpackages) }} +{% endif %}