Usage

termynal usage documentation.

Installation

Install termynal directly from pypi using pip:

pip install sphinxcontrib-termynal

To activate the extension you must add it to your conf.py file:

# docs/conf.py

extensions = [
    ...
    "sphinxcontrib.termynal",
    ...
]

Usage

Here we demonstrate how one could display the termynal roles directives.

demo-directive

The package is providing a demo-directive:

rst

.. demo-directive:: This is a demo directive.

MyST

```{demo-directive} This is a demo directive.
```

And here is the result :

This is a demo directive.

demo-role

The package is providing a demo-role:

reStructuredText

I'm an :demo-role:`demo` role.

MyST

I'm an {demo-role}`demo` role.

And here is the result :

I’m an demo role.