.. signac documentation master file, created by
   sphinx-quickstart on Fri Oct 23 17:41:32 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to signac's documentation!
==================================

.. image:: images/minimal.svg
    :align: right

.. automodule:: signac

Contents
--------

.. glossary::

    :ref:`overview`
      An illustration of **signac**'s workflow and data model.

    :ref:`tutorial`
      Compact demonstration of the implementation of a computational workflow.

    :ref:`guide`
      A complete introduction to the framework's major components.

    :ref:`quickreference`
      Brief overview of the core functions, to serve as reference.

    :ref:`api`
      The complete API reference.

.. attention::

    The **signac** package is hosted on `bitbucket <https://bitbucket.org/glotzer/signac>`_ and licensed under the open-source BSD 3-Clause license.

.. toctree::
   :hidden:
   :maxdepth: 3

   overview
   tutorial
   guide
   reference
   signac

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. signac documentation master file, created by
   sphinx-quickstart on Fri Oct 23 17:41:32 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to signac's documentation!
==================================

.. image:: images/minimal.svg
    :align: right

.. automodule:: signac

Contents
--------

.. glossary::

    :ref:`overview`
      An illustration of **signac**'s workflow and data model.

    :ref:`tutorial`
      Compact demonstration of the implementation of a computational workflow.

    :ref:`guide`
      A complete introduction to the framework's major components.

    :ref:`quickreference`
      Brief overview of the core functions, to serve as reference.

    :ref:`api`
      The complete API reference.

Support and Contribution
------------------------

To get help using the signac package, either send an email to `signac-support@umich.edu <mailto:signac-support@umich.edu>`_ or join the `signac hipchat channel <https://www.hipchat.com/gGxEbx62Z>`_.

The **signac** package is hosted on `bitbucket <https://bitbucket.org/glotzer/signac>`_ and licensed under the open-source BSD 3-Clause license.
Please use the `repository's issue tracker <https://bitbucket.org/glotzer/signac/issues?status=new&status=open>`_ to report bugs or request new features.

.. toctree::
   :hidden:
   :maxdepth: 3

   overview
   tutorial
   guide
   reference
   signac

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Add links to mailing list, hipchat channel and issue tracker.
Add links to mailing list, hipchat channel and issue tracker.
