.. pydfmux documentation master file.
   To build HTML documentation, use something like
      $ sphinx-build . _build

Welcome to `pydfmux`
====================

Welcome to pydfmux! This documentation is hosted in ``pydfmux/docs`` and can be
rebuilt using the "Sphinx" tool. To rebuild documentation from scratch, run::

   $ export PYDFMUX_OUT_DIR=/tmp/pydfmux
   $ cd pydfmux/docs
   $ make

You can then find HTML documentation in ``pydfmux/docs/build/html``.

Hardware
--------

.. toctree::
   :maxdepth: 1

   hardware/quality_control/mezzanine_quality_control
   hardware/timestamps

Software
--------
.. toctree::
   :maxdepth: 1

   software/dependencies
   software/introduction
   software/object_model
   software/algorithms
   software/yaml
   software/troubleshooting
   software/profiling
   software/sequential
   software/changelog

Firmware
--------

.. toctree::
   :maxdepth: 1

   firmware/firmware
   firmware/signal_path
   firmware/release_notes
   firmware/netbooting

Integration
-----------

.. toctree::
   :maxdepth: 1

   integration/unpacking
   integration/networking
   integration/streaming

Guides
------

.. toctree::
   :maxdepth: 1

   guides/setting_up
   guides/using_pydfmux
   guides/cancino_qc_guide.rst
   guides/example_hwm_queries.rst
   guides/autogenerate_hwms.rst
   
Debugging
---------

.. toctree::
   :maxdepth: 1

   debugging/parser_trouble

Indices and tables
------------------

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

.. vim: sts=3 ts=3 sw=3 tw=78 smarttab expandtab