.. -*- rst -*-

.. highlightlang:: none

ドキュメント作成
================

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

Groongaのドキュメントは、Sphinxというツールを用いて作成されています。Sphinxは以下のように導入します。::

 # aptitude install python-setuptools
 # easy_install -U sphinx

htmlの作成
----------------

以下のコマンドでhtmlが作成されます。::

 % make html

This document is also ditributed in forms of release source archive and updated time to time.
If you want to refer latest documentation in source form, you can view such files via GitHub repository browser (https://github.com/groonga/groonga/tree/master/doc/source).

pdfの作成
---------------

Groongaのドキュメントは、pdf出力することもできます。rst2pdfと、IPAフォント(IPA Gothic/IPAexGothic)が必要となります。

rst2pdfのインストール
^^^^^^^^^^^^^^^^^^^^^^^^^^^

以下のようにしてインストールできます。::

 # easy_install rst2pdf

pdfの作成
^^^^^^^^^^^^^^^

以下のコマンドでpdfが作成されます。::

 % make pdf
