Sha256: 6bfefad174583ab5f02350521bb9991692a537f5f7c37098c7de757f1c28597f
Contents?: true
Size: 1.55 KB
Versions: 44
Compression:
Stored size: 1.55 KB
Contents
.. -*- rst -*- .. highlightlang:: none Introduction ============ This documentation describes about how to write, generate and manage Groonga documentation. Install depended software ------------------------- Groonga uses Sphinx_ as documentation tool. .. _Sphinx: http://sphinx.pocoo.org/ Here are command lines to install 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 Run ``configure`` with ``--enable-document`` -------------------------------------------- Groonga disables documentation generation by default. You need to enable it explicitly by adding ``--enable-document`` option to ``configure``:: % ./configure --enable-document Now, your Groonga build is documentation ready. Generate HTML ------------- You can generate HTML by the following command:: % make -C doc html You can find generated HTML documentation at ``doc/locale/en/html/``. Update ------ You can find sources of documentation at ``doc/source/``. The sources should be written in English. See :doc:`i18n` about how to translate documentation. You can update the target file when you update the existing documentation file. You need to update file list after you add a new file, change file path and delete existing file. You can update file list by the following command:: % make -C doc update-files The command updates ``doc/files.am``.
Version data entries
44 entries across 22 versions & 1 rubygems