インストールしたい
$ pip3 install sphinx
pip3
コマンドでSphinx
パッケージをインストールします。
テーマしたい
$ pip3 install テーマのパッケージ名
デフォルトのテーマはalabaster
ですが、あまり日本語に向いていません(と感じます)。
SphinxのテーマもPythonパッケージとして公開されています。 Sphinx Theme Galleryなどから、自分の好みのテーマを探してインストールしてください。
僕はsphinx_rtd_theme
やsphinx_book_theme
をよく使っています。
このドキュメントもRead the Docs Sphinx Themeを使っています。
$ pip3 install sphinx_rtd_theme
$ pip3 install sphinx_book_theme
詳しくはテーマの使い方にまとめておきます。
Markdownしたい
1$ pip3 install myst-parser
myst-parser
パッケージをインストールし、MyST(Markedly Structured Text)
というMarkdownを拡張した記法でSphinx文書が作成できるようにします。
reST
記法で書いていたことが、ほぼMarkdown
記法で書けるようになりとても便利です。
注釈
このドキュメントのサンプルもMyST
で書いています。