mirror of
https://github.com/readthedocs/sphinx-autoapi
synced 2024-11-08 07:10:31 +00:00
1c6c9f15d8
The .NET detail page was slightly messy, this cleans up and settles on some UX there: * Don't use an explicit header for summary, move it up under the object heading * Drop redundant (and broken) github edit link on page, we need to fix the github header link instead. * Add pattern for displaying read only fields in definition list * Adds namespace + assemblies listing to detail page Refs #60
88 lines
1.4 KiB
ReStructuredText
88 lines
1.4 KiB
ReStructuredText
{% block title %}
|
|
|
|
{{ obj.short_name }} {{ obj.type.title()}}
|
|
{{ "=" * (obj.short_name|length + obj.type|length + 1) }}
|
|
|
|
{% endblock %}
|
|
|
|
{% block summary %}
|
|
{%- if obj.summary %}
|
|
|
|
{{ obj.summary }}
|
|
|
|
{%- endif %}
|
|
{% endblock %}
|
|
|
|
{%- if obj.namespace %}
|
|
Namespace
|
|
:dn:ns:`{{ obj.namespace }}`
|
|
{%- endif %}
|
|
{%- if obj.assemblies %}
|
|
Assemblies
|
|
{%- for assembly in obj.assemblies %}
|
|
* {{ assembly }}
|
|
{%- endfor %}
|
|
{%- endif %}
|
|
|
|
----
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
{% 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|indent(4) }}
|
|
|
|
{% endif %}
|
|
|
|
{% endblock %}
|
|
|
|
|
|
{% block content %}
|
|
|
|
.. dn:{{ obj.ref_type }}:: {{ obj.definition }}
|
|
:hidden:
|
|
|
|
.. dn:{{ obj.ref_type }}:: {{ obj.name }}
|
|
|
|
{%- for item_type in obj.item_map.keys() %}
|
|
{%- 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, []) %}
|
|
{{ obj_item.render()|indent(4) }}
|
|
{% endfor %}
|
|
|
|
{%- endif %}
|
|
{%- endfor %}
|
|
|
|
{% endblock %}
|