Skip to content

Labscript utils docs #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
32 changes: 32 additions & 0 deletions docs/source/_templates/autosummary-class.rst
Original file line number Diff line number Diff line change
@@ -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 %}
66 changes: 66 additions & 0 deletions docs/source/_templates/autosummary-module.rst
Original file line number Diff line number Diff line change
@@ -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 %}
8 changes: 0 additions & 8 deletions docs/source/api/connections.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/dict_diff.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/double_import_denier.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/filewatcher.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/h5_lock.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/impprof.rst

This file was deleted.

62 changes: 5 additions & 57 deletions docs/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 0 additions & 8 deletions docs/source/api/labconfig.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/source/api/labscript_utils.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/ls_zprocess.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/memprof.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/modulewatcher.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/properties.rst

This file was deleted.

78 changes: 0 additions & 78 deletions docs/source/api/qtwidgets.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/remote.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/api/settings.rst

This file was deleted.

Loading