angelinsky7 / docker-sphinx-build Goto Github PK

Sphinx documents builder on docker container.

docker 1.7+

sphinx-quickstart ./sphinx-docs

git clone your_repository_path sphinx-docs

docker run -it --rm \
  -v `pwd`/sphinx-docs:/sphinx-docs \
  -e SPHINX_DOC_ROOT=/sphinx-docs \
  -e SPHINX_BUILDER=singlehtml \
  sonodar/sphinx-build

this example, output to ./sphinx-docs/_build

SPHINX_DOC_ROOT (optional:default=/sphinx)

Sphinx project path in container.

Use docker volumes.

SPHINX_BUILDER (optional:default=html)

Sphinx make command argument.

REQUIREMENTS_FILE (optional)

pip install -r $REQUIREMENTS_FILE on pre-build.

Must be included SPHINX_DOC_ROOT.