Tarantool documentation source, published at https://www.tarantool.io/en/doc/1.10/
How to build Tarantool documentation using Docker
docker build -t tarantool-doc-builder .Run this command only if you don't have untracked files! check it by
git statusAlso failures during git submodule update can be fixed by:
git submodule deinit -f .
git submodule update --initInit and update submodules:
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "./update_submodules.sh"or do it manually:
git submodule init
git submodule update
git pull --recurse-submodules
git submodule update --remote --mergeInit 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"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make epub"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make epub-ru"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make update-pot"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make update-po"
docker run --rm -it -v $(pwd):/doc tarantool-doc-builder sh -c "make update-po-force"using python3 built-in server:
cd output/html
python3 -m http.serveror python2 built-in server:
cd output/html
python -m SimpleHTTPServerthen go to localhost:8000 in your browser.
Install required packages:
npm install -g clean-css clean-css-cli node-less less-plugin-autoprefix Make css files:
cd _theme/tarantool/_less
make allThen remove output/html folder and build the documentation again
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
.pofiles 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