Add Sphinx build environment in Docker

Custom Docker file including: - support for Python (required by Sphinx) - Java (required by plantuml plugin) - a few Sphinx plugins also required for other SLAV stack projects (refer to the Dockerfile) This image does not provide `python`. Please use `python3`. Change-Id: I10cf39a0fe0dc3cf35c9110b2680cca9a799ee0e Signed-off-by: Michal Sidor <[email protected]>
SamsungSLAV · Oct 16, 2018 · ef8a468 · ef8a468
1 parent ef7ef37
commit ef8a468
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -0,0 +1,17 @@
+DOCKER_IMAGE = muxpi-doc-image
+DOCKER_CONTAINER = muxpi-doc-container
+DOCKER_CONTAINER_WORKDIR = /doc
+
+.PHONY: all clean build-docker-image clean-docker
+
+all: build-docker-image
+
+clean: clean-docker
+
+build-docker-image:
+	docker build -t ${DOCKER_IMAGE} docker
+
+clean-docker:
+	-docker rm ${DOCKER_CONTAINER}
+	-docker rmi ${DOCKER_IMAGE}
+
diff --git a/doc/docker/Dockerfile b/doc/docker/Dockerfile
@@ -0,0 +1,21 @@
+FROM alpine:3.8
+LABEL maintainer="Michal Sidor <[email protected]>"
+
+ENV PLANTUML_VERSION 1.2018.8
+
+RUN mkdir -p /opt/plantuml \
+ && wget https://sourceforge.net/projects/plantuml/files/plantuml.${PLANTUML_VERSION}.jar/download -O /opt/plantuml/plantuml.jar
+RUN apk --no-cache add python3 make openjdk8-jre-base graphviz ttf-freefont \
+    libjpeg-turbo zlib tiff \
+ && apk --no-cache add -t .makedepends libjpeg-turbo-dev zlib-dev tiff-dev \
+    python3-dev build-base
+RUN pip3 install --upgrade pip setuptools \
+ && pip3 install 'Pillow >=5.2.0,<5.3' 'Sphinx >=1.8.0,<1.9' \
+    'sphinxcontrib-plantuml ==0.11' 'sphinxcontrib-actdiag >=0.8.0,<0.9' \
+    'sphinxcontrib-blockdiag >=1.5.0,<1.6' 'sphinxcontrib-seqdiag >=0.8.0,<0.9' \
+ && apk --no-cache del .makedepends
+
+ENV DATA_DIR=/doc JAVA_HOME=/usr/lib/jvm/java-1.8-openjdk
+
+WORKDIR $DATA_DIR
+VOLUME $DATA_DIR