doc¶
Enterprise documentation
Before building documentation¶
Install LDoc and make it available at /usr/local/ldoc/ldoc.lua
sudo git clone -b rst https://github.com/tarantool/LDoc.git /usr/local/ldoc
Initialize submodules if modules directories is empty
make modules-init
Build rst sources from submodules
make modules-rst
Updating submodules¶
Update each submodule to its current master branch on GitHub.
Note: it will undo any changes made locally.
make modules-update
Check the state and remote setting of each submodule:
make modules-diagnostics
How to build documentation using Docker¶
Pull tarantool/doc-builder image¶
docker pull tarantool/doc-builder
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 -p 8000:8000 -v $(pwd):/doc tarantool/doc-builder sh -c "make autobuild"
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"
Then find documentation in _output folder