sphinx-evita

[!warning] Early access preview. See disclaimer below.

Sphinx plugins and theme customizations for the EVITA project.

Purpose

This package includes customizations primarily meant for authoring modules in the EVITA project. The implementation is however general purpose and maybe reused for any project, which uses:

• sphinx-lesson based markup for writing content, and
• furo as the theme

Installation

Install into your python environment with:

pip install sphinx-evita

Then in the Sphinx conf.py file add:

...
extensions = [
    # other extensions
    "sphinx_evita",
]

[!note] The official EVITA module template is pre-configured to use this.

Disclaimer

🇪🇺 Funded by the European Union. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the granting authority (European High-Performance Computing Joint Undertaking: EuroHPC JU). Neither the European Union nor the granting authority can be held responsible for them.

Early access preview: This material should be regarded as a "living tool" open for improvement and its content may be subject to modifications without notice. It has not yet undergone formal review by the EuroHPC JU and is shared for informational purposes only.