Merge pull request #79 from dihm/labscript_utils-docs

Update docs to match autogenerating templates used in other modules of labscript.

Author: dihm

.gitignore

@@ -158,4 +158,5 @@ conda_packages/
 # Sphinx documentation
 docs/html/
 docs/source/_build/
-docs/source/components.rst
+docs/source/components.rst
+docs/source/api/_autosummary

docs/source/_templates/autosummary-class.rst

@@ -0,0 +1,32 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% 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 %}

docs/source/_templates/autosummary-module.rst

@@ -0,0 +1,66 @@
+{{ fullname | escape | underline}}
+
+{% block submodules %}
+{% if modules %}
+.. rubric:: {{ _('Sub-Modules') }}
+.. autosummary::
+   :toctree: 
+   :template: autosummary-module.rst
+   :recursive:
+
+   {% for item in modules %}
+   {{ item }}
+   {%- endfor %}
+{% endif %}
+{% endblock %}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Module Attributes') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: autosummary-class.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/source/api/connections.rst

@@ -2,62 +2,10 @@
 API Reference
 *************
 
-Labscript Tools
-~~~~~~~~~~~~~~~
-
-.. toctree::
-   :maxdepth: 2
+.. autosummary::
+   :toctree: _autosummary
+   :template: autosummary-module.rst
+   :recursive:
 
    labscript_utils
-   connections
-   dict_diff
-   labconfig
-   settings
-   testing_utils
-   properties
-   unitconversions
-
-Communications
-~~~~~~~~~~~~~~
-
-.. toctree::
-   :maxdepth: 2
-
-   h5_lock
-   ls_zprocess
-   remote
-   shared_drive
-   zlock
-   zlog
-
-GUI
-~~~~
-
-.. toctree::
-   :maxdepth: 2
-
-   splash
-   qtwidgets
-
-Logging and Profiling
-~~~~~~~~~~~~~~~~~~~~~
-
-.. toctree::
-   :maxdepth: 2
-
-   impprof
-   memprof
-   setup_logging
-   tracelog
-
-
-Module and File Tools
-~~~~~~~~~~~~~~~~~~~~~
-
-.. toctree::
-   :maxdepth: 2 
-   
-   double_import_denier
-   filewatcher
-   modulewatcher
-   versions
+   labscript_profile