12.2.1. Introduction#

This documentation describes about how to write, generate and manage Groonga documentation.

12.2.1.1. Install depended software#

Groonga uses Sphinx as documentation tool.

Here are command lines to install 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. Run cmake with --preset=doc#

Groonga disables documentation generation by default. You need to enable it explicitly by adding --preset=doc option to cmake:

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

Now, your Groonga build is documentation ready.

12.2.1.3. Generate HTML#

You can generate HTML by the following command:

% cmake --build ../groonga.doc

You can find generated HTML documentation at ../groonga.doc/doc/en/html/.

12.2.1.4. Update#

You can find sources of documentation at doc/source/. The sources should be written in English. See I18N about how to translate documentation.

You can update the target file when you update the existing documentation file.