Sphinx Documentation Builder Docker Image

Minimalistic Alpine-based Sphinx builder image without any custom themes installed. This image is intented to be used in CI environments, so no watch/autobuild-features included.

Features

• Based on official Alpine 3.7 Python 3.6.6 image
• Markdown support included via recommonmark and m2r extensions
• Multiple sources support included via sphinx-multibuild
• No custom themes included. You should create your own image with the desired theme like this:

FROM procraft/sphinx-doc:1.7.5

RUN pip install sphinx_rtd_theme && \
    rm -rf $PIP_CACHE_DIR/*

Usage

docker run --rm -it \
  -v $(pwd)/docs:/docs \
  procraft/sphinx-doc \
  sphinx-multibuild -i doc-source-1 -i doc-source-2 -o built-docs -c .

Links

Got some good ideas from this well-made image: https://hub.docker.com/r/webuni/sphinx-doc/~/dockerfile/