mirror of
https://github.com/calebstewart/pwncat.git
synced 2024-11-30 20:34:15 +01:00
cd163045be
Very close to API documentation complete for #95
35 lines
783 B
Plaintext
35 lines
783 B
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 pkgname == "pwncat" %}
|
|
{{- "API Documentation" | e | heading }}
|
|
{% else %}
|
|
{%- if is_namespace %}
|
|
{{- [pkgname, "namespace"] | join(" ") | e | heading }}
|
|
{% else %}
|
|
{{- [pkgname, "package"] | join(" ") | e | heading }}
|
|
{% endif %}
|
|
{% endif %}
|
|
|
|
{%- if modulefirst and not is_namespace %}
|
|
{{ automodule(pkgname, automodule_options) }}
|
|
{% endif %}
|
|
|
|
{%- if (subpackages+submodules) %}
|
|
Modules and Packages
|
|
--------------------
|
|
{{ toctree(subpackages+submodules) }}
|
|
{% endif %}
|