.. _documentation:

Documentation
=============

Documentation on the modules of the Reaction Plane Fit package are available below. For getting started, take
a look at :meth:`reaction_plane_fit.example.run_fit`.

.. toctree::
   :maxdepth: 3

   api/base
   api/functions
   api/fit
   api/three_orientations
   api/example

Some additional helpful links:

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

For any code contributions, please be certain to document:

* New functions, arguments, and classes.
* New attributes of classes.

All of the above can be documented in the source, with the exception of adding new modules to the docs. The
new modules must be added in the ``docs/api`` folder.