update autosummary

tataratat · Jun 20, 2023 · a247ff4 · a247ff4
1 parent 8784518
commit a247ff4
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 16 deletions.
diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst
@@ -3,15 +3,21 @@
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
+   :show-inheritance:
 
    {% block methods %}
 
    {% if methods %}
    .. rubric:: {{ _('Methods') }}
 
    .. autosummary::
+      :toctree:
    {% for item in methods %}
-      ~{{ name }}.{{ item }}
+      {% if item not in skipmethods %}
+        {% if item not in inherited_members %}
+          {{ name }}.{{ item }}
+        {% endif %}
+      {% endif %}
    {%- endfor %}
    {% endif %}
    {% endblock %}
@@ -21,8 +27,11 @@
    .. rubric:: {{ _('Attributes') }}
 
    .. autosummary::
+      :toctree:
    {% for item in attributes %}
-      ~{{ name }}.{{ item }}
+      {% if item not in inherited_members %}
+         {{ name }}.{{ item }}
+      {% endif %}
    {%- endfor %}
    {% endif %}
    {% endblock %}
diff --git a/docs/source/_templates/autosummary/module.rst b/docs/source/_templates/autosummary/module.rst
@@ -1,3 +1,5 @@
+.. _{{ fullname }}:
+
 {{ fullname | escape | underline}}
 
 .. automodule:: {{ fullname }}
@@ -32,6 +34,7 @@
 
    .. autosummary::
       :toctree:
+      :template:
    {% for item in classes %}
       {{ item }}
    {%- endfor %}

diff --git a/docs/source/api_references.rst b/docs/source/api_references.rst
@@ -0,0 +1,17 @@
+API References
+==============
+
+Overview
+--------
+- :class:`splinepy.splinepy_core` is a module that includes all the c++ bindings. Most importantly, :class:`.PySpline` and :class:`.PyMultiPatch` are implemented here, which serve bases for all the derived spline types with in the library. It only contains minimal documentation, as the classes and methods are derived / integrated throughout the library with proper documentations on python side.
+- :class:`.Spline` extends / documents :class:`.PySpline`. Common features for all splines are implemented here. We recommend using :class:`.Bezier`, :class:`.RationalBezier`, :class:`.BSpline`, or :class:`.NURBS` in front-end applications.
+- :class:`.BezierBase` extends :class:`.Spline` with features available for Bezier-families. It becomes a basis for :class:`.Bezier` and :class:`.RationalBezier`, where the derived classes implement appropriate initializations.
+- :class:`.BSplineBase` extends :class:`.Spline` with features available for BSpline-famlilies. It becomes a basis for :class:`.BSpline` and :class:`.NURBS`, where derived classes implements appropriate initializations.
+- :class:`.Multipatch` extends / documents :class:`.PyMultiPatch`.
+- :class:`splinepy.helpme` module contains useful application-driven tools / utility functions.
+
+
+splinepy
+--------
+.. toctree::
+   full_api
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -27,7 +27,6 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
-    "sphinx.ext.inheritance_diagram",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
@@ -51,11 +50,6 @@
     "autosummary": True,
 }
 
-# def skip(app, what, name, obj, would_skip, options):
-#    if name == "__init__":
-#        return False
-#
-#    return would_skip
-#
-# def setup(app):
-#    app.connect("autodoc-skip-member", skip)
+autosummary_context = {
+    "skipmethods": ["__init__"],
+}
diff --git a/docs/modules.rst → docs/source/full_api.rst b/docs/modules.rst → docs/source/full_api.rst
@@ -1,9 +1,6 @@
-API references
---------------
-
 .. autosummary::
    :toctree: _autosummary
    :template:
    :recursive:
 
-    splinepy
+   splinepy
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -21,7 +21,7 @@ Related Links and further Information
 .. toctree::
    :maxdepth: 1
 
-   API references <_autosummary/splinepy>
+   API references <api_references>
 
 .. Indices and tables
 .. ==================