Skip to content

jayant-ism/doc

 
 

Repository files navigation

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 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.

About

Tarantool documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 36.8%
  • Less 22.6%
  • Python 20.0%
  • HTML 8.3%
  • JavaScript 7.9%
  • CMake 3.2%
  • Other 1.2%