Open5
Sphinxの拡張パッケージ
sphinx-copybutton
- コードブロックの右上に
コピー
ボタンを追加できる -
conf.py
のextensions
に追加するだけで使えるの、よい
myst-parser
- SphinxでMarkdownするための必須パッケージ
- MySTはMarkdownの方言の一つ
- CommonMarkのsupersetに、reST記法(ロールとディレクティブの概念)をとりんだもの
- Markdownがシンプルな故に不便だった部分が、解消されている感じがする
myst-nb
-
.ipynb
形式をSphinxのページとして使えるようになる - PyPIにあるバージョンは、依存パッケージのバージョン上限がついているので、新しめの
myst_parser
などが使えない。そのため、GitHubを指定してpoetry add
した。
$ poetry add --group=docs git+https://github.com/executablebooks/MyST-NB.git
-
myst_nb
を使う場合はmyst_parser
をコメントアウトする-
myst_nb
をロードするとmyst_parser
もロードされるため - 両方を
extensions
に書くと、変数が二重に定義されたりしてエラーがでる
-
extensions = [
...,
# "myst_parser",
"myst_nb",
...,
]
- ``myst-parser``とdoujini
sphinx-favicon
- あとで使ってみる
sphinxext-opengraph
- OGP情報を追加できるパッケージ
-
extensions
に追加するだけで使える - 追加で設定できるオプションもある