summaryrefslogtreecommitdiff
path: root/util
diff options
context:
space:
mode:
authorPatrick Georgi <patrick@georgi.software>2018-04-26 14:29:20 +0200
committerPhilipp Deppenwiese <zaolin.daisuki@gmail.com>2018-04-27 20:01:54 +0000
commita2faac2168c2630683f8097aeaf9e5cdb57d561e (patch)
treee397626ead8bbb310973ec01d4b67bdba3078666 /util
parent5c9df70031b7d14c01b8bf261510cc9a8828eabc (diff)
downloadcoreboot-a2faac2168c2630683f8097aeaf9e5cdb57d561e.tar.xz
util/docker: Add docker container that builds the sphinx documentation
It's what we use on coreboot.org to update www.coreboot.org/Documentation Change-Id: I6e5457d2e39a10f14fabd68bbb231a05e2f66f1d Signed-off-by: Patrick Georgi <patrick@georgi.software> Reviewed-on: https://review.coreboot.org/25869 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com> Reviewed-by: Martin Roth <martinroth@google.com> Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Diffstat (limited to 'util')
-rw-r--r--util/docker/docs.coreboot.org/Dockerfile5
-rw-r--r--util/docker/docs.coreboot.org/README.md3
2 files changed, 8 insertions, 0 deletions
diff --git a/util/docker/docs.coreboot.org/Dockerfile b/util/docker/docs.coreboot.org/Dockerfile
new file mode 100644
index 0000000000..fa2313cabc
--- /dev/null
+++ b/util/docker/docs.coreboot.org/Dockerfile
@@ -0,0 +1,5 @@
+FROM debian:sid
+RUN apt-get update && apt-get install -y make python-sphinx python-recommonmark python-sphinx-rtd-theme
+USER nobody
+VOLUME /data-in /data-out
+ENTRYPOINT bash -c "cd /data-in/Documentation && make sphinx BUILDDIR=/tmp/build && rm -rf /data-out/* && mv /tmp/build/html/* /data-out/"
diff --git a/util/docker/docs.coreboot.org/README.md b/util/docker/docs.coreboot.org/README.md
new file mode 100644
index 0000000000..11c095d18e
--- /dev/null
+++ b/util/docker/docs.coreboot.org/README.md
@@ -0,0 +1,3 @@
+How to use:
+
+docker run --rm -v $path-to-coreboot.git:/data-in:ro -v $path-to-html-output:/data-out $image