Metadata-Version: 2.3
Name: sphinx-evita
Version: 0.1.0b1
Summary: Sphinx plugins and theme customizations for the EVITA project
Author: Ashwin V. Mohanan
Author-email: Ashwin V. Mohanan <ashwin.mohanan@enccs.se>
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Documentation :: Sphinx
Requires-Dist: furo>=2025.9.25
Requires-Dist: sphinx>=8.2.3
Requires-Dist: sphinx-lesson>=0.8.16
Requires-Dist: sphinxcontrib-bibtex>=2.6.5
Requires-Dist: myst-parser>=4.0.1 ; extra == 'docs'
Requires-Dist: sphinx-design>=0.6.1 ; extra == 'docs'
Requires-Python: >=3.11
Provides-Extra: docs
Description-Content-Type: text/markdown

# sphinx-evita

[![PyPI](https://img.shields.io/pypi/v/sphinx-evita)](https://pypi.org/project/sphinx-evita/)
[![Build Status](https://img.shields.io/github/actions/workflow/status/ENCCS/sphinx-evita/build.yaml?branch=main)](https://github.com/ENCCS/sphinx-evita/actions)
[![Documentation Status](https://readthedocs.org/projects/sphinx-evita/badge/?version=latest)](https://sphinx-evita.readthedocs.io/en/latest/?badge=latest)

<!--begin-description-->
Sphinx plugins and theme customizations for the EVITA project.

## Purpose

This package includes customizations primarily meant for authoring modules in the [EVITA](https://www.evitahpc.eu) project.
The implementation is however general purpose and maybe reused for any project, which uses:

- [sphinx-lesson](https://coderefinery.github.io/sphinx-lesson) based markup for writing content, and
- [furo](https://pradyunsg.me/furo/) as the theme

## Installation

Install into your python environment with:

```console
pip install sphinx-evita
```

Then in the Sphinx conf.py file add:

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

<!--end-description-->

> [!NOTE]
> The official [EVITA template](https://github.com/ENCCS/evita-material-template/) is pre-configured to use this.