v0.10.0

doc/Doc-License.rst

@@ -1,8 +1,8 @@
 .. _DOCLICENSE:
 
-.. Note:: This is a local copy of the `Creative Commons - Attribution 4.0 International (CC BY 4.0) <https://creativecommons.org/licenses/by/4.0/legalcode>`__.
+.. note:: This is a local copy of the `Creative Commons - Attribution 4.0 International (CC BY 4.0) <https://creativecommons.org/licenses/by/4.0/legalcode>`__.
 
-.. Attention:: This **CC BY 4.0** license applies only to the **documentation** of this project.
+.. attention:: This **CC BY 4.0** license applies only to the **documentation** of this project.
 
 
 Creative Commons Attribution 4.0 International

doc/Glossary.rst

@@ -0,0 +1,22 @@
+Glossary
+########
+
+.. glossary::
+
+   AppVeyor
+     tbd
+
+   CI
+     tbd
+
+   GitHub Actions
+     tbd
+
+   GitLab-CI
+     tbd
+
+   Travis-CI
+     tbd
+
+   Version
+     tbd

doc/TODO.rst

@@ -0,0 +1,4 @@
+TODOs
+#####
+
+.. todolist::

doc/_templates/autoapi/module.rst

@@ -0,0 +1,160 @@
+.. # Template modified by Patrick Lehmann
+     * removed automodule on top, because private members are activated for autodoc (no doubled documentation).
+     * Made sections like 'submodules' bold text, but no headlines to reduce number of ToC levels.
+
+{{ '=' * node.name|length }}
+{{ node.name }}
+{{ '=' * node.name|length }}
+
+.. automodule:: {{ node.name }}
+
+{##}
+{%- block modules -%}
+{%- if subnodes %}
+
+**Submodules**
+
+.. toctree::
+   :maxdepth: 1
+{% for item in subnodes %}
+   {{ item.name }}
+{%- endfor %}
+{##}
+{%- endif -%}
+{%- endblock -%}
+{##}
+.. currentmodule:: {{ node.name }}
+{##}
+
+{%- if node.variables %}
+
+**Variables**
+
+{% for item, obj in node.variables.items() -%}
+- :py:data:`{{ item }}`
+  {#{ obj|summary }#}
+{% endfor -%}
+{%- endif -%}
+
+{%- if node.functions %}
+
+**Functions**
+
+{% for item, obj in node.functions.items() -%}
+- :py:func:`{{ item }}`:
+  {{ obj|summary }}
+
+{% endfor -%}
+{%- endif -%}
+
+{%- if node.exceptions %}
+
+**Exceptions**
+
+{% for item, obj in node.exceptions.items() -%}
+- :py:exc:`{{ item }}`:
+  {{ obj|summary }}
+
+{% endfor -%}
+{%- endif -%}
+
+{%- if node.classes %}
+
+**Classes**
+
+{% for item, obj in node.classes.items() -%}
+- :py:class:`{{ item }}`:
+  {{ obj|summary }}
+
+{% endfor -%}
+{%- endif -%}
+
+{%- block variables -%}
+{%- if node.variables %}
+
+---------------------
+
+**Variables**
+
+{#% for item, obj in node.variables.items() -%}
+- :py:data:`{{ item }}`
+{% endfor -%#}
+
+{% for item, obj in node.variables.items() %}
+.. autodata:: {{ item }}
+   :annotation:
+
+   .. code-block:: text
+
+      {{ obj|pprint|indent(6) }}
+{##}
+{%- endfor -%}
+{%- endif -%}
+{%- endblock -%}
+
+{%- block functions -%}
+{%- if node.functions %}
+
+---------------------
+
+**Functions**
+
+{% for item in node.functions %}
+.. autofunction:: {{ item }}
+{##}
+{%- endfor -%}
+{%- endif -%}
+{%- endblock -%}
+
+{%- block exceptions -%}
+{%- if node.exceptions %}
+
+---------------------
+
+**Exceptions**
+
+{#% for item, obj in node.exceptions.items() -%}
+- :py:exc:`{{ item }}`:
+  {{ obj|summary }}
+
+{% endfor -%#}
+
+{% for item in node.exceptions %}
+.. autoexception:: {{ item }}
+
+   .. rubric:: Inheritance
+   .. inheritance-diagram:: {{ item }}
+      :parts: 1
+{##}
+{%- endfor -%}
+{%- endif -%}
+{%- endblock -%}
+
+{%- block classes -%}
+{%- if node.classes %}
+
+---------------------
+
+**Classes**
+
+{#% for item, obj in node.classes.items() -%}
+- :py:class:`{{ item }}`:
+  {{ obj|summary }}
+
+{% endfor -%#}
+
+{% for item in node.classes %}
+.. autoclass:: {{ item }}
+   :members:
+   :private-members:
+   :special-members:
+   :inherited-members:
+   :exclude-members: __weakref__
+
+   .. rubric:: Inheritance
+   .. inheritance-diagram:: {{ item }}
+      :parts: 1
+{##}
+{%- endfor -%}
+{%- endif -%}
+{%- endblock -%}