atsphinx-audioplayer

概要

このライブラリは、HTMLのオーディオ関連機能をサポートするためのSphinx拡張です。使用することで、あなたが管理するSphinxドキュメント上でオーディオファイルを再生できるようになります。

• Change logs

インストール

依存ライブラリとして登録します。

pip install atsphinx-audioplayer

conf.py 上に、Sphinx拡張として登録します。

extensions = [
    "atsphinx.audioplayer",
]

使用法

ディレクティブとロールの2種類の方法で、オーディオ再生のための記述ができます。

ディレクティブの記述例

RST

.. audio:: example.mp3

MD

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

ロールの記述例

RST

:audio:`example.mp3`

MD

{audio}`example.mp3`

ロールを使うことで、文中にオーディオ要素 を挿入することができます。

Sphinx拡張としての設定

現在は、拡張全般に渡る設定項目がありません。

定義済みディレクティブ

.. audio::

:no-controls: (bool)

このオプションを指定すると、出力時の audio 要素から controls 属性が除外されます。「要素自体は使用したいがユーザーに操作させない」ときに使用できます。