|docs|_  |github|_  |pypi|_  |doi|_  |joss|_

.. |docs| image:: https://img.shields.io/badge/%F0%9F%95%AE-docs-green.svg
.. _docs: https://cea-metrocarac.github.io/fitspy/doc/index.html

.. |github| image:: https://img.shields.io/badge/GitHub-GPL--3.0-informational
.. _github: https://github.com/CEA-MetroCarac/fitspy

.. |pypi| image:: https://badge.fury.io/py/fitspy.svg
.. _pypi: https://pypi.org/project/fitspy

.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10812333.svg
.. _doi: https://doi.org/10.5281/zenodo.10812333

.. |joss| image:: https://joss.theoj.org/papers/971a02868d903c0b7c0cbc3d1cd3d139/status.svg
.. _joss: https://joss.theoj.org/papers/971a02868d903c0b7c0cbc3d1cd3d139


Welcome to the Fitspy documentation !
=====================================

.. toctree::
   :caption: User Guide

   user_guide/intro.rst
   user_guide/input_data.rst
   user_guide/baseline.rst
   user_guide/peak_models.rst
   user_guide/fitting.rst
   user_guide/workflow.rst
   user_guide/auto_mode.rst
   user_guide/gui.rst
   user_guide/outputs.rst


.. toctree::
   :caption: Release Notes

   release_notes/release_notes.rst


.. toctree::
   :caption: Developers Guide

   dev_guide/dev_notes.rst


.. toctree::
   :maxdepth: 3
   :caption: API References
   :titlesonly:

   api/modules.rst