mirror of
https://github.com/evennia/evennia.git
synced 2026-03-29 12:07:17 +02:00
Add doc templates from develop
This commit is contained in:
parent
fbfd662937
commit
aa623651a1
2 changed files with 55 additions and 0 deletions
1
docs/source/_templates/layout.html
Normal file
1
docs/source/_templates/layout.html
Normal file
|
|
@ -0,0 +1 @@
|
|||
{%- extends "!layout.html" %}
|
||||
54
docs/source/_templates/package.rst_t
Normal file
54
docs/source/_templates/package.rst_t
Normal file
|
|
@ -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 %}
|
||||
Loading…
Add table
Add a link
Reference in a new issue