summaryrefslogtreecommitdiff
path: root/docs/source/_templates/module.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/_templates/module.rst')
-rw-r--r--docs/source/_templates/module.rst57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/source/_templates/module.rst b/docs/source/_templates/module.rst
new file mode 100644
index 0000000..5ad89be
--- /dev/null
+++ b/docs/source/_templates/module.rst
@@ -0,0 +1,57 @@
+{{ fullname }}
+{{ underline }}
+
+.. automodule:: {{ fullname }}
+
+ {% block functions %}
+ {% if functions %}
+
+ Functions
+ ---------
+
+ {% for item in functions %}
+
+ .. autofunction:: {{ item }}
+
+ .. include:: backreferences/{{fullname}}.{{item}}.examples
+
+ .. raw:: html
+
+ <div class="sphx-glr-clear"></div>
+
+ {%- endfor %}
+ {% endif %}
+ {% endblock %}
+
+ {% block classes %}
+ {% if classes %}
+
+ Classes
+ -------
+
+ {% for item in classes %}
+ .. autoclass:: {{ item }}
+ :members:
+
+ .. include:: backreferences/{{fullname}}.{{item}}.examples
+
+ .. raw:: html
+
+ <div class="sphx-glr-clear"></div>
+
+ {%- endfor %}
+ {% endif %}
+ {% endblock %}
+
+ {% block exceptions %}
+ {% if exceptions %}
+
+ Exceptions
+ ----------
+
+ .. autosummary::
+ {% for item in exceptions %}
+ {{ item }}
+ {%- endfor %}
+ {% endif %}
+ {% endblock %} \ No newline at end of file