HTML版ドキュメントの生成

目次:

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

  • 概要

  • Sphinxのインストール

  • ドキュメントのHTML化

概要

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

Sphinxのインストール

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

$ pip install sphinx

ドキュメントのHTML化

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

$ make html

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