diff options
| author | Patrick Georgi <pgeorgi@google.com> | 2019-12-10 20:27:38 +0100 |
|---|---|---|
| committer | Patrick Georgi <pgeorgi@google.com> | 2019-12-12 08:18:49 +0000 |
| commit | a73317e5cff3d104d567c341b114d242e0c0e5c0 (patch) | |
| tree | 7366781ce486cdd1a740c9590419bbe40c11b1cf | |
| parent | 5ee82832503ab46affbc5f12ce1088046e8ae28c (diff) | |
Documentation: enable ditaa integration
For prettier diagrams: http://ditaa.sourceforge.net/
Change-Id: Ic28dc5ea9d82ff6bf8654e2e33e675a536348654
Signed-off-by: Patrick Georgi <pgeorgi@google.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/37646
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
| -rw-r--r-- | Documentation/conf.py | 2 | ||||
| -rw-r--r-- | util/docker/doc.coreboot.org/Dockerfile | 9 | ||||
| -rwxr-xr-x | util/docker/doc.coreboot.org/ditaa.sh | 2 |
3 files changed, 12 insertions, 1 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py index 85df9ea51e..8848ee6512 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -25,6 +25,8 @@ release = subprocess.check_output(('git', 'describe')).decode("utf-8") # The short X.Y version. version = release.split("-")[0] +extensions = ['sphinxcontrib.ditaa'] + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # diff --git a/util/docker/doc.coreboot.org/Dockerfile b/util/docker/doc.coreboot.org/Dockerfile index d05e8b5835..23f5f50403 100644 --- a/util/docker/doc.coreboot.org/Dockerfile +++ b/util/docker/doc.coreboot.org/Dockerfile @@ -2,14 +2,21 @@ FROM alpine:3.8 COPY makeSphinx.sh /makeSphinx.sh -RUN apk add --no-cache python3 make bash git \ +ADD https://sourceforge.net/projects/ditaa/files/ditaa/0.9/ditaa0_9.zip/download /tmp/ditaa.zip + +RUN apk add --no-cache python3 make bash git openjdk8-jre ttf-dejavu fontconfig \ && pip3 install --upgrade --no-cache-dir pip \ && pip3 install --no-cache-dir \ sphinx===1.8.3 \ sphinx_rtd_theme===0.4.2 \ recommonmark===0.5.0 \ sphinx_autobuild===0.7.1 \ + sphinxcontrib-ditaa===0.6 \ && chmod 755 /makeSphinx.sh +RUN cd /tmp \ + && unzip ditaa.zip \ + && mv ditaa0_9.jar /usr/lib +ADD ditaa.sh /usr/bin/ditaa VOLUME /data-in /data-out diff --git a/util/docker/doc.coreboot.org/ditaa.sh b/util/docker/doc.coreboot.org/ditaa.sh new file mode 100755 index 0000000000..5f27f53497 --- /dev/null +++ b/util/docker/doc.coreboot.org/ditaa.sh @@ -0,0 +1,2 @@ +#!/bin/sh +exec java -jar /usr/lib/ditaa0_9.jar $* |