12.2.1. 導入#

この文書では、Groongaドキュメントの執筆・生成・管理の方法について説明します。

12.2.1.1. 必要なソフトウェアのインストール#

Groongaはドキュメントツールとして Sphinx を使います。

以下はSphinxをインストールするコマンドラインです。

Debian GNU/Linux, Ubuntu:

% sudo apt-get install -V -y python3-pip gettext
% sudo pip install -r doc/requirements.txt
% (cd doc && bundle install)

CentOS, Fedora:

% sudo yum install -y python-pip gettext
% sudo pip install -r doc/requirements.txt
% (cd doc && bundle install)

OS X:

% brew install python
% brew install gettext
% export PATH=`brew --prefix gettext`/bin:$PATH
% pip install -r doc/requirements.txt
% (cd doc && bundle install)

12.2.1.2. cmake--preset=doc 付きで実行#

Groonga は、デフォルトではドキュメントの生成を無効化しています。 cmake--preset=doc オプションを追加して明示的に有効にする必要があります。:

% cmake -S . -B ../groonga.doc --preset=doc

これで、 Groonga ドキュメントをビルドする準備が出来ました。

12.2.1.3. HTMLファイルを生成#

以下のコマンドでHTMLファイルを生成できます。:

% cmake --build ../groonga.doc

生成されたHTMLドキュメントは ../groonga.doc/doc/ja/html/ にあります。

12.2.1.4. 更新#

ドキュメントのソースは doc/source/ にあります。ソースは英語で書かれているはずです。ドキュメントの翻訳方法については、 国際化 をご覧ください。

既に存在するドキュメントのファイルを更新すると、翻訳対象のファイルを更新できます。