mirror of
https://github.com/readthedocs/sphinx-autoapi
synced 2024-11-06 09:20:27 +00:00
87a16ea421
This resolves some issues with special characters in paths on Windows based systems. It replaces special characters and unicode characters to ensure paths are predictable.
65 lines
1.1 KiB
ReStructuredText
65 lines
1.1 KiB
ReStructuredText
{% block title %}
|
|
|
|
{{ obj.name }} {{ obj.type.title() }}
|
|
{{ "=" * (obj.name|length + obj.type|length + 1) }}
|
|
|
|
{% endblock %}
|
|
|
|
{% block toc %}
|
|
|
|
{% if obj.children %}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:maxdepth: 2
|
|
|
|
{% for item in obj.children|sort %}
|
|
{% if item.type != 'namespace' %}
|
|
/autoapi/{{ item.pathname }}/index
|
|
{% endif %}
|
|
{% endfor %}
|
|
|
|
|
|
{% endif %}
|
|
|
|
{% if obj.references %}
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:maxdepth: 2
|
|
|
|
{% for item in obj.references|sort %}
|
|
{% if item.type != 'namespace' %}
|
|
/autoapi/{{ item.pathname }}/index
|
|
{% endif %}
|
|
{% endfor %}
|
|
|
|
{% endif %}
|
|
|
|
{% endblock %}
|
|
|
|
|
|
{% block content %}
|
|
|
|
{%- macro display_type(item_type) %}
|
|
|
|
.. rubric:: {{ item_type.title() }}
|
|
|
|
{%- for obj_item in obj.item_map.get(item_type, []) %}
|
|
{% macro render() %}{{ obj_item.summary }}{% endmacro %}
|
|
|
|
{{ obj_item.type }} :dn:{{ obj_item.ref_directive }}:`{{ obj_item.ref_name }}`
|
|
{{ render()|indent(8) }}
|
|
|
|
{%- endfor %}
|
|
{%- endmacro %}
|
|
|
|
.. dn:{{ obj.ref_type }}:: {{ obj.name }}
|
|
|
|
{%- for item_type in obj.item_map.keys() %}
|
|
{{ display_type(item_type) }}
|
|
{%- endfor %}
|
|
|
|
|
|
{% endblock %}
|