A community-maintained Python framework for creating mathematical animations.
use napoleon instead of numpydoc. Also add a new template for class autosummaries
leotrs7185c77734bf
diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rstnew file mode 100644index 000000000..827c0b0e1--- /dev/null+++ b/docs/source/_templates/autosummary/class.rst@@ -0,0 +1,29 @@+{{ fullname | escape | underline}}++.. currentmodule:: {{ module }}++.. autoclass:: {{ objname }}++ {% block methods %}+ {% if methods %}+ .. rubric:: {{ _('Methods') }}++ .. autosummary::+ :nosignatures:+ :toctree: .+ {% 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 %}diff --git a/docs/source/_templates/autosummary/module.rst b/docs/source/_templates/autosummary/module.rstindex 95eed5735..260a4d4a2 100644--- a/docs/source/_templates/autosummary/module.rst+++ b/docs/source/_templates/autosummary/module.rst@@ -35,7 +35,6 @@{% for class in classes %}{{ class }}{% endfor %}-{% endif %}{% endblock %}diff --git a/docs/source/conf.py b/docs/source/conf.pyindex dcefbbc2d..002fc21f2 100644--- a/docs/source/conf.py+++ b/docs/source/conf.py@@ -31,7 +31,8 @@ extensions = ['sphinx.ext.autodoc','sphinx_rtd_theme','recommonmark',- 'numpydoc',+ 'sphinx.ext.napoleon',+ 'sphinx.ext.autosummary']autosummary_generate = True