Sha256: 40eef5ab579ea583515e0ce36e6cd12d3f9e256e02f03e3111c77a2f39deafdf

Contents?: true

Size: 862 Bytes

Versions: 2

Compression:

Stored size: 862 Bytes

Contents

.. highlightlang:: none

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

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

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

 # aptitude install python-setuptools
 # easy_install -U sphinx

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

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

 % make html

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

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

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

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

 # eazy_install rst2pdf

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

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

 % make pdf

Version data entries

2 entries across 1 versions & 1 rubygems

Version Path
rroonga-1.0.1-x86-mingw32 vendor/local/share/groonga/doc/ja/source/developer/document.txt
rroonga-1.0.1-x86-mingw32 vendor/local/share/groonga/doc/ja/html/_sources/developer/document.txt