Docs
====

.. image::
    ../_static/figs/docs/banner-1.svg
   :alt: Project-Rat-Extras Docs banner
   :align: left
   :class: img-bottom-padding
   :width: 100 %

\- *Who put their teeth in them papers...*

-----

`PRE Docs`_ serves as a global documentation portal for the
whole PRE_ group in order to centralize information and knowledge in
the form of a Sphinx_ static website to be hosted on GitLab pages.

It uses its own custom Sphinx theme: Meral, which combines the
classic `Alabaster`_ and `Python documentation`_ themes for light
and dark modes, with additional tweaking here and there. Check the
``meral`` directory `Meral theme Python module`_ in GitLab repo.

This section documents... well the documentation itself! It is
much simpler than other PRE_ projects, but it it still useful
to keep information or other tips and tricks about what is going
on to build these static pages. See the `docs repository`_ for
more information

.. Docs table of contents
.. toctree::
   :maxdepth: 2
   :caption: DOCS CONTENTS

   structure
   setup_build_use
   relations
   meral

.. Links
.. _Alabaster: https://alabaster.readthedocs.io/en/latest/index.html
.. _docs repository: https://gitlab.com/project-rat-extras/docs
.. _`Meral theme Python module`: https://gitlab.com/project-rat-extras/docs/-/blob/main/docs/source/_themes/meral
.. _PRE: https://gitlab.com/project-rat-extras
.. _PRE Docs: https://gitlab.com/project-rat-extras/docs
.. _Python documentation: https://sphinx-themes.org/sample-sites/python-docs-theme/
.. _Sphinx: https://www.sphinx-doc.org/en/master/index.html