.. py:currentmodule:: lsst.faro.summary

.. _lsst.faro.summary:

#################
lsst.faro.summary
#################

.. Paragraph that describes what this Python module does and links to related modules and frameworks.

.. .. _lsst.faro.summary-using:

.. Using lsst.faro.summary
.. ==================

.. toctree linking to topics related to using the module's APIs.

.. .. toctree::
..    :maxdepth: 1

.. _lsst.faro.summary-contributing:

Contributing
============

``lsst.faro.summary`` is developed at https://github.com/lsst/faro.
You can find Jira issues for this module under the `faro <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20faro>`_ component.

.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.

.. .. toctree::
..    :maxdepth: 1

.. _lsst.faro.summary-pipeline-tasks:

Pipeline tasks
--------------

.. lsst-pipelinetasks::
   :root: lsst.faro.summary

.. _lsst.faro.summary-tasks:

Tasks
-----

.. lsst-tasks::
   :root: lsst.faro.summary
   :toctree: tasks

.. _lsst.faro.summary-configs:

Configurations
--------------

.. lsst-configs::
   :root: lsst.faro.summary
   :toctree: configs

.. .. _lsst.faro.summary-scripts:

.. Script reference
.. ================

.. .. TODO: Add an item to this toctree for each script reference topic in the scripts subdirectory.

.. .. toctree::
..    :maxdepth: 1

.. .. _lsst.faro.summary-pyapi:

Python API reference
====================

.. automodapi:: lsst.faro.summary
   :no-main-docstr:
   :no-inheritance-diagram: