mirror of
https://github.com/readthedocs/sphinx-autoapi
synced 2024-11-10 01:10:27 +00:00
85 lines
1.3 KiB
ReStructuredText
85 lines
1.3 KiB
ReStructuredText
{% block title %}
|
|
|
|
{{ obj.short_name }} {{ obj.type.title()}}
|
|
{{ "=" * (obj.short_name|length + obj.type|length + 1) }}
|
|
|
|
{% endblock %}
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
{% block summary %}
|
|
{%- if obj.summary %}
|
|
|
|
Summary
|
|
-------
|
|
|
|
{{ obj.summary }}
|
|
|
|
{%- endif %}
|
|
{% endblock %}
|
|
|
|
{% block inheritance %}
|
|
|
|
{%- if obj.inheritance %}
|
|
|
|
Inheritance Hierarchy
|
|
---------------------
|
|
|
|
{%- for item in obj.inheritance %}
|
|
* :dn:{{ item.ref_directive }}:`{{ item.ref_name }}`
|
|
{%- endfor %}
|
|
* :dn:{{ obj.ref_directive }}:`{{ obj.ref_name }}`
|
|
{%- endif %}
|
|
|
|
{% endblock %}
|
|
|
|
{% block syntax %}
|
|
|
|
{%- if obj.example %}
|
|
|
|
Syntax
|
|
------
|
|
|
|
.. code-block:: csharp
|
|
|
|
{{ obj.example }}
|
|
|
|
{%- endif %}
|
|
|
|
{% endblock %}
|
|
|
|
GitHub
|
|
------
|
|
|
|
`View on GitHub <{{ obj.edit_link }}>`_
|
|
|
|
|
|
|
|
{% block content %}
|
|
|
|
.. dn:{{ obj.ref_type }}:: {{ obj.name }}
|
|
|
|
{%- macro display_type(item_type) %}
|
|
{%- if item_type in obj.item_map %}
|
|
|
|
{{ item_type.title() }}
|
|
{{ "-" * item_type|length }}
|
|
|
|
.. dn:{{ obj.ref_type }}:: {{ obj.name }}
|
|
:noindex:
|
|
:hidden:
|
|
|
|
{%- for obj_item in obj.item_map.get(item_type, []) %}
|
|
{% macro render() %}{{ obj_item.render() }}{% endmacro %}
|
|
{{ render()|indent(4) }}
|
|
{%- endfor %}
|
|
{%- endif %}
|
|
{%- endmacro %}
|
|
|
|
{%- for item_type in obj.item_map.keys() %}
|
|
{{ display_type(item_type) }}
|
|
{%- endfor %}
|
|
|
|
{% endblock %}
|