.. CMItemplate documentation master file
   This file should at least contain the root `toctree` directive.

CMI Python-project template documentation
=========================================

This package_ serves as a template for CMI Python projects.

User documentation
------------------

.. toctree::
   :maxdepth: 4

   installation
   user-guide


Developer documentation
-----------------------

The full documentation of the source code is available in the following subpages. This includes, for
instance, available classes and methods, and their respective parameters and return values.

.. toctree::
   :maxdepth: 4

   cmitemplate
   developer-guide
   todolist


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

.. toctree::
   :maxdepth: 4

   references

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


.. _package: https://github.com/CFEL-CMI/CMI-Python-project-template


.. comment
   Local Variables:
   coding: utf-8
   mode: fly-spell
   fill-column: 100
   truncate-lines: t
   End: