HTML版ドキュメントの生成
==========================

.. contents:: 目次:
    :depth: 3

概要
###########################

IROHA2のドキュメントはreStructuredText形式で作成し、Sphinxを用いてHTML化している。
ここではSphinxによるドキュメントのHTML化手順について説明する。

Sphinxのインストール
###########################

Sphinxはpipでインストールする。

.. code-block:: bash

    $ pip install sphinx

ドキュメントのHTML化
###########################

:file:`Makefile` のあるディレクトリ（ :file:`IROHA2/docs/` ）で以下のコマンドを実行する。

.. code-block:: bash

    $ make html

htmlファイルや画像ファイル等が含まれたディレクトリ :file:`build/html/` が生成する。