From: Akihiro Motoki <amotoki@gmail.com>
Date: Thu, 18 Feb 2016 13:19:55 +0000 (+0900)
Subject: guide: Update instruction on how to build the guide
X-Git-Tag: util-linux-2.12r~35
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=3d2cf8eb0dd53141a5f85dc47e41dacc867dee80;p=linuxjm%2Fjm.git

guide: Update instruction on how to build the guide
---

diff --git a/guide/document_help.rst b/guide/document_help.rst
index f12380ea..42ba03d5 100644
--- a/guide/document_help.rst
+++ b/guide/document_help.rst
@@ -5,11 +5,34 @@
 このドキュメントは Sphyinx を使って作成しています。
 ReST 記法が利用できるので、お手軽、かつ多様な表現が可能です。
 
+格納場所
+========
+
+ドキュメントのソースは git repository の ``guide/`` ディレクトリに
+あります。
+
 ドキュメント build 方法
 =======================
 
+build 環境の準備
+----------------
+
+自分の環境でドキュメントの build を確認するには sphinx をインストールする
+必要があります。
+
+.. code-block:: console
+
+   $ pip install -r requirements.txt
+
+上記のコマンドを有効にすると、
+sphinx と sphinx-bootstrap-theme がインストールされます。
+
+build 方法
+----------
+
 .. code-block:: console
 
+   $ cd <JM_GIT_REPO_TOP>/guide
    $ make html
 
 作成されたドキュメントを破棄して作り直すには以下のようにします。
diff --git a/guide/requirements.txt b/guide/requirements.txt
new file mode 100644
index 00000000..00502794
--- /dev/null
+++ b/guide/requirements.txt
@@ -0,0 +1,2 @@
+Sphinx
+sphinx-bootstrap-theme