diff options
author | RĂ©mi Flamary <remi.flamary@gmail.com> | 2020-04-28 09:50:45 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-04-28 09:50:45 +0200 |
commit | afedeebf5bdd58ff92f52c73b9b41b8a8e66ca29 (patch) | |
tree | 60fafb54d66aa843965c000d48d249780afdcf75 /docs/source/_templates/module.rst | |
parent | b53fb23b538e0b7f6498bc217f02adac3c8f7d07 (diff) | |
parent | 3b0732b041d46df66cb182b17f6ece040c578722 (diff) |
Merge pull request #160 from PythonOT/doc_cov
[MRG] Update documentation and improve coverage
Diffstat (limited to 'docs/source/_templates/module.rst')
-rw-r--r-- | docs/source/_templates/module.rst | 57 |
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 |