OSDN Git Service

guide: Update instruction on how to build the guide
authorAkihiro Motoki <amotoki@gmail.com>
Thu, 18 Feb 2016 13:19:55 +0000 (22:19 +0900)
committerAkihiro Motoki <amotoki@gmail.com>
Thu, 18 Feb 2016 13:20:44 +0000 (22:20 +0900)
guide/document_help.rst
guide/requirements.txt [new file with mode: 0644]

index f12380e..42ba03d 100644 (file)
@@ -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 (file)
index 0000000..0050279
--- /dev/null
@@ -0,0 +1,2 @@
+Sphinx
+sphinx-bootstrap-theme