ドキュメントのビルド・カスタム方法

このページではWindows環境でビルドする方法をまとめています.
Linuxの場合にはmake.batをmakeコマンドとして読み替えてください.
また, その場合はmakeがインストールされている必要があります.
その他, ディレクトリ操作なども適宜読み替えてください.

全てのディレクトリのパスはリポジトリのルートディレクトリからのパスです.

ビルドする

リポジトリのルートでコンソールを開き, .\docs\make.bat htmlを実行します.

実行後, \docs\build\html\index.htmlが生成されるので, IDEのプレビュー機能なり, ローカルにHTTPサーバを立ち上げるなりすることで, ローカルでドキュメントを参照できます.

カスタムする

プラグインなどを追加するには, \docs\source\conf.pyを書き換えてください.

ページを追加するときは, Markdown (.md) か ReStructuredText (.rst) でコンテンツを書くことができます.
コンテンツを書いたあと、\docs\source\index.rstのtoctree::配下に拡張子抜きのファイル名を書くことで, コンテンツへのリンクをサイドバーとindex.htmlに追加できます.

ReStructuredTextの文法は検索してください.