インストールしたい(sphinx)
// uv toolを使ってシステム全体にインストール
$ uv tool install sphinx
// uvを使ってプロジェクトに追加
$ uv add --group docs sphinx
// テーマを追加
$ uv add --group docs sphinx_rtd_theme
$ uv add --group docs sphinx_book_theme
// Markdown (MyST) を追加
$ uv add --group docs myst-parser
Sphinxはuvでインストールできます。
インストールした後は、sphinx-buildコマンドが使えるようになります。
デフォルトのテーマであるalabasterは、あまり日本語に向いていないと感じるため、
sphinx_rtd_themeやsphinx_book_themeなどのテーマもインストールしておくとよいでしょう。
このドキュメントもRead the Docs Sphinx Themeを使っています。
myst-parserを追加すると、MyST記法で記述できるようになります。
MySTは、Markedly Structured Textの略で、Markdownを拡張した記法です。
Markdown記法の手軽さに、
reST(reStructuredText)記法の構造化を追加できます。
このドキュメントもMyST記法で書いています。