.. ---------------------------------------------------------------------
..
.. PartExa - A Particle Library for the Exa-Scale
..
.. Copyright (C) 2022 by the PartExa authors
..
.. This program is free software: you can redistribute it and/or modify
.. it under the terms of the GNU General Public License as published by
.. the Free Software Foundation, either version 3 of the License, or
.. (at your option) any later version.
..
.. This program is distributed in the hope that it will be useful,
.. but WITHOUT ANY WARRANTY; without even the implied warranty of
.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.. GNU General Public License for more details.
..
.. You should have received a copy of the GNU General Public License
.. along with this program. If not, see <https://www.gnu.org/licenses/>.
..
.. ---------------------------------------------------------------------

.. toctree::
   :hidden:

.. _documentation:

Documentation
-------------

Writing reliable documentation of a software project is an essential part in software development.
In this context, important aspects are amongst others to provide a getting started guide and
installation instructions, to give an overview of implemented feautures, and to cover source code
documentation. Hence, proper documentation improves the quality of a software project as it
facilitates development and maintability, and ensures transfer of knowledge amongst users and
developers. For this reason, within PartExa it is mandatory to write and keep documentation up to
date.

The documentation of PartExa is twofold:

* Installation and development guides are provided within a Sphinx-based documentation.
* Source code documentation is generated using Doxygen.

.. note::

   Recent precomiled versions of the `Sphinx <https://partexa.github.io/PartExa-Sphinx/>`_ and
   `Doxygen <https://partexa.github.io/PartExa-Doxygen/>`_ documentation are provided online.

Sphinx documentation
~~~~~~~~~~~~~~~~~~~~

Todo!

Doxygen documentation
~~~~~~~~~~~~~~~~~~~~~

Todo!