bhavenger / doc

Tarantool documentation

doc

Tarantool documentation source, published at https://www.tarantool.io/en/doc/1.10/

How to build Tarantool documentation using Docker

Build docker image

docker build -t tarantool-doc-builder .

Build Tarantool documentation using tarantool-doc-builder image

Init make commands:

docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "cmake ."

Run a required make command inside tarantool-doc-builder container:

docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make html"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make html-ru"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make singlehtml"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make singlehtml-ru"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make pdf"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make pdf-ru"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make json"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make json-ru"

Run documentation locally on your machine

using python3 built-in server:

cd output/html
python3 -m http.server

or python2 built-in server:

cd output/html
python -m SimpleHTTPServer

then go to localhost:8000 in your browser.

How to contribute

To contribute to documentation, use the REST 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.

Notes:

• 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