Skip to content

Improve toctree in documentation #779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VisLab merged 2 commits into from
Oct 23, 2023
Merged

Improve toctree in documentation #779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04acff8
Improve toctree in documentation
IanCa Oct 20, 2023
1406760
Don't draw full titles. Full names are still drawn some other places
IanCa Oct 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 0 additions & 34 deletions docs/source/_templates/autosummary/class.rst
View file
Open in desktop

This file was deleted.

68 changes: 39 additions & 29 deletions docs/source/_templates/custom-class-template.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,42 @@
{{ fullname | escape | underline}}
{{ fullname.split('.')[-1] | escape | underline }}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
:members:
:show-inheritance:
:inherited-members:

{% block methods %}
.. automethod:: __init__

{% if methods %}
.. rubric:: {{ _('Methods') }}

.. autosummary::
{% for item in methods %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}

{% block attributes %}
{% if attributes %}
.. rubric:: {{ _('Attributes') }}

.. autosummary::
{% for item in attributes %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
.. autoclass:: {{ module }}.{{ objname }}
:noindex:

.. rubric:: {{ _('Methods') }}

.. autosummary::
{% for item in methods %}
{{ module }}.{{ objname }}.{{ item }}
{%- endfor %}

.. rubric:: {{ _('Attributes') }}

.. autosummary::
{% for item in attributes %}
{{ module }}.{{ objname }}.{{ item }}
{%- endfor %}

.. toctree::
:hidden:

{% for item in methods %}
{{ fullname }}#method-{{ item }}
{%- endfor %}
{% for item in attributes %}
{{ fullname }}#attribute-{{ item }}
{%- endfor %}

{% for item in methods %}
.. _method-{{ item }}:

.. automethod:: {{ module }}.{{ objname }}.{{ item }}
{%- endfor %}

{% for item in attributes %}
.. _attribute-{{ item }}:

.. autoattribute:: {{ module }}.{{ objname }}.{{ item }}
{%- endfor %}
29 changes: 18 additions & 11 deletions docs/source/_templates/custom-module-template.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{{ fullname | escape | underline}}
{{ fullname.split('.')[-1] | escape | underline}}

.. currentmodule:: {{ module }}

.. automodule:: {{ fullname }}

Expand All @@ -14,17 +16,22 @@
{% endif %}
{% endblock %}

{% block functions %}
{% if functions %}
.. rubric:: {{ _('Functions') }}
{% block functions %}
{% if functions %}
.. rubric:: {{ _('Functions') }}

.. autosummary::
:toctree:
{% for item in functions %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
.. autosummary::
{% for item in functions %}
{{ item }}
{% endfor %}

{% for item in functions %}
.. _{{ item }}:

.. autofunction:: {{ item }}
{% endfor %}
{% endif %}
{% endblock %}

{% block classes %}
{% if classes %}
Expand Down
4 changes: 2 additions & 2 deletions docs/source/api2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
HED API reference (Auto style)
==============================
HED API reference
=================

.. currentmodule:: hed

Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Hierarchical Event Descriptor (HED) Python Tools
Note: this is a work in progress. More information is coming.

.. toctree::
:maxdepth: 4
:maxdepth: 6
:caption: Contents:

introduction.md
user_guide.rst

.. toctree::
:maxdepth: 4
:maxdepth: 6
:caption: HED Python API:

api2.rst
Expand Down