Meral
=====

Meral is the hand crafted Sphinx theme used for PRE_ documentation.
It lies deep within the `docs repository`_, under the 
``docs/docs/source/_themes/meral`` subdirectory.

This subdictory follows the stucture of a basic Python module with
the additions of files and patterns to make it a `Sphinx theme`_.

Meral is born from the Alabaster_ theme, and has been upgraded
using the `Python Documentation theme`_ in order to add a dark
mode along with some admonition tweaks.

| It only serves as a local theme for PRE_ for now and is now released.
| In fact it is very much NOT ready to be released since it has been
| *Frankensteined* in many unfathomable ways.

There are still many things to fix, mainly CSS styling dual definition 
between light and dark mode which are very split and repetitive.

Admonitions
-----------

Here are the rendering of the admonitions with the Meral theme.

.. topic::
   A topic

   This project is under active development.

.. admonition::
   An admonition

   Some charm, yes

   This project is under active development.

.. attention::

   This project is under active development.

.. caution::

   This project is under active development.

.. danger::

   This project is under active development.

.. error::

   This project is under active development.

.. hint::

   This project is under active development.

.. important::

   This project is under active development.

.. note::

   This project is under active development.

.. seealso::

   This project is under active development.

.. tip::

   This project is under active development.

.. warning::

   This project is under active development.

.. Links
.. _Alabaster: https://alabaster.readthedocs.io/en/latest/index.html
.. _docs repository: https://gitlab.com/project-rat-extras/docs
.. _PRE: https://gitlab.com/project-rat-extras
.. _Python Documentation theme: https://sphinx-themes.org/sample-sites/python-docs-theme/
.. _Sphinx theme: https://www.sphinx-doc.org/en/master/development/html_themes/index.html