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

このページでは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の文法は検索してください.