Order plot functions last (#555)

Signed-off-by: zethson <lukas.heumos@posteo.net>
scverse · Mar 11, 2024 · f525f99 · f525f99
1 parent e6ec187
commit f525f99
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 5 deletions.
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
@@ -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 %}
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -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"