guide/document_help.rst

   1 ====================
   2 ドキュメント編集メモ
   3 ====================
   4
   5 このドキュメントは Sphyinx を使って作成しています。
   6 ReST 記法が利用できるので、お手軽、かつ多様な表現が可能です。
   7
   8 格納場所
   9 ========
  10
  11 ドキュメントのソースは git repository の ``guide/`` ディレクトリに
  12 あります。
  13
  14 ドキュメント build 方法
  15 =======================
  16
  17 build 環境の準備
  18 ----------------
  19
  20 自分の環境でドキュメントの build を確認するには sphinx をインストールする
  21 必要があります。
  22
  23 .. code-block:: console
  24
  25    $ pip install -r requirements.txt
  26
  27 上記のコマンドを有効にすると、
  28 sphinx と sphinx-bootstrap-theme がインストールされます。
  29
  30 build 方法
  31 ----------
  32
  33 .. code-block:: console
  34
  35    $ cd <JM_GIT_REPO_TOP>/guide
  36    $ make html
  37
  38 作成されたドキュメントを破棄して作り直すには以下のようにします。
  39
  40 .. code-block:: console
  41
  42    $ make clean
  43    $ make html
  44
  45 参考情報
  46 ========
  47
  48 * `reStructuredText入門 <http://docs.sphinx-users.jp/rest.html#lists-and-quote-like-blocks>`_
  49 * `インラインマークアップ <http://docs.sphinx-users.jp/markup/inline.html>`_
  50 * `Sphinxドキュメント <http://docs.sphinx-users.jp/contents.html>`_