Version:

Building documentation

Tarantool documentation is built using a simplified markup system named Sphinx
(see http://sphinx-doc.org). You can build a local version of this documentation
and you can contribute to Tarantool’s version.

You need to install these packages:

git (a program for downloading source repositories)

CMake version 2.8 or later (a program for managing the build process)

Python version greater than 2.6 – preferably 2.7 – and less than 3.0
(Sphinx is a Python-based tool)

LaTeX (a system for document preparation; the installable
package name usually begins with the word ‘texlive’ or ‘tetex’, on Ubuntu
the name is ‘texlive-latex-base’)

ImageMagick (a system for image conversion; on MacOS install it using
brew)

The entry point for each version is the index.html file in the appropriate
directory.

Set up a web-server.

Run the following command to set up a web-server. The example below is for
Ubuntu, but the procedure is similar for other supported operating systems.
Make sure to run it from the documentation output folder,
output/en or output/ru, as in the example below:

$cd ~/tarantool-doc/output/en
$ python -m SimpleHTTPServer 8000

Open your browser and enter 127.0.0.1:8000/doc/2.0 into the address box. If
your local documentation build is valid, the manual will appear in the browser.

To contribute to documentation, use the .rst format for drafting and
submit your updates as a
pull request
via GitHub.

To comply with the writing and formatting style, use the
guidelines provided in the documentation,
common sense and existing documents.

Note

If you suggest creating a new documentation section (a whole new
page), it has to be saved to the relevant section at GitHub.

If you want to contribute to localizing this documentation (for example into
Russian), add your translation strings to .po files stored in the
corresponding locale directory (for example /locale/ru/LC_MESSAGES/
for Russian). See more about localizing with Sphinx at
http://www.sphinx-doc.org/en/stable/intl.html