12.2.1. 導入#

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

12.2.1.1. Groongaリポジトリをフォークしクローンする方法#

Groongaドキュメントへ貢献するには、まずはGroongaリポジトリをフォークしクローンするとこから始めます。そうすることで、あなたのリポジトリで個人的な変更や実験が可能になります。他にも、その成果をGroongaリポジトリにあなたの貢献として送ることもできます。まずは、次の手順に倣って、フォークとクローンをしてください。

  1. GitHubの groonga/groonga へ移動してください。

  2. Fork ボタンをクリックして、Groongaリポジトリをフォークしてください。

  3. 下記のコマンドでフォークしたGroongaリポジトリをクローンしてください。

% git clone --recursive git@github.com:${YOUR_GITHUB_ACCOUNT}/groonga.git

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

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

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

Debian GNU/Linux, Ubuntu:

% ./setup.sh
% sudo pip install -r doc/requirements.txt
% (cd doc && bundle install)

AlmaLinux, Fedora:

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

macOS:

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

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

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

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

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

12.2.1.4. HTMLファイルを生成#

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

% cmake --build ../groonga.doc

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

12.2.1.5. 更新#

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

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