Skip to content
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

Jump to bottom

Order plot functions last #555

Merged
merged 1 commit into from
Mar 11, 2024
Merged

Order plot functions last #555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 17 additions & 3 deletions docs/_templates/autosummary/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,25 @@ Methods table
~~~~~~~~~~~~~

.. autosummary::

{% set plotting_methods = [] %}
{% set other_methods = [] %}

{% for item in methods %}
{%- if item != '__init__' %}
{%- if item.startswith('plot_') %}
{%- set _ = plotting_methods.append(item) %}
{% elif item != '__init__' %}
{%- set _ = other_methods.append(item) %}
{%- endif %}
{% endfor %}

{% for item in other_methods %}
~{{ fullname }}.{{ item }}
{%- endif -%}
{%- endfor %}
{% endfor %}

{% for item in plotting_methods %}
~{{ fullname }}.{{ item }}
{% endfor %}
{% endif %}
{% endblock %}

Expand Down
3 changes: 1 addition & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@
HERE = Path(__file__).parent
sys.path[:0] = [str(HERE.parent), str(HERE / "extensions")]

needs_sphinx = "4.3" # Nicer param docs
needs_sphinx = "4.3"

# General information about the project.
project = "pertpy"
copyright = "2021, Lukas Heumos, Theislab"
author = "Lukas Heumos"
Expand Down
Loading