doc

Tarantool documentation

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 sphinx-html"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make sphinx-html-ru"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make sphinx-singlehtml"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make sphinx-singlehtml-ru"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make sphinx-pdf"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make sphinx-pdf-ru"

Run documentation locally on your machine

using python3 built-in server:

cd output
python3 -m http.server

or python2 built-in server:

cd output
python -m SimpleHTTPServer

then go to localhost:8000 in your browser.