12.2.1. 導入¶
この文書では、Groongaドキュメントの執筆・生成・管理の方法について説明します。
12.2.1.1. 必要なソフトウェアのインストール¶
Groongaはドキュメントツールとして Sphinx を使います。
以下はSphinxをインストールするコマンドラインです。
Debian GNU/Linux, Ubuntu:
% sudo apt-get install -V -y python-sphinx
CentOS, Fedora:
% sudo yum install -y python-pip
% sudo pip install sphinx
OS X:
% brew install python
% brew install gettext
% export PATH=`brew --prefix gettext`/bin:$PATH
% pip install sphinx
プラットフォームに存在するPythonのバージョンが古すぎる場合は、Python 2.7のより新しいバージョンを手動でインストールする必要があります。例えば、 pyenv を使ったインストール手順は以下の通りです:
% pyenv install 2.7.11
% pyenv global 2.7.11
% pip install sphinx
12.2.1.2. configure を --enable-document 付きで実行¶
Groonga は、デフォルトではドキュメントの生成を無効化しています。 configure に --enable-document オプションを追加して明示的に有効にする必要があります。:
% ./configure --enable-document
これで、 Groonga ドキュメントをビルドする準備が出来ました。
12.2.1.3. HTMLファイルを生成¶
以下のコマンドでHTMLファイルを生成できます。:
% make -C doc html
生成されたHTMLドキュメントは doc/locale/ja/html/ にあります。
12.2.1.4. 更新¶
ドキュメントのソースは doc/source/ にあります。ソースは英語で書かれているはずです。ドキュメントの翻訳方法については、 国際化 をご覧ください。
既に存在するドキュメントのファイルを更新すると、翻訳対象のファイルを更新できます。
新規ファイル追加・ファイル位置変更・ファイル削除の後は、ファイル一覧を更新する必要があります。以下のコマンドでファイル一覧を更新できます。:
% make -C doc update-files
このコマンドは doc/files.am を更新します。