atsphinx-audioplayer

Overview

This is Sphinx extension that renders html content for playing audio files. You can display your audio media contents with documentation by this.

• Change logs

Installation

Register this as dependencies.

pip install atsphinx-audioplayer

And, set as extension into your conf.py.

extensions = [
    "atsphinx.audioplayer",
]

Usage

You can write directive or role to insert audio control.

Directive style

RST

.. audio:: example.mp3

MD

```{audio} example.mp3
```

Role style

RST

:audio:`example.mp3`

MD

{audio}`example.mp3`

You can insert audio element in line.

Configuration for extension

Currently, this does not have configuration settings.

Defined directives

.. audio::

:no-controls: (bool)

If this is set, write audio element excluded controls attribute. You can use for register audio element without user control interface.