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>
This commit is contained in:
@@ -25,6 +25,8 @@ release = subprocess.check_output(('git', 'describe')).decode("utf-8")
|
|||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = release.split("-")[0]
|
version = release.split("-")[0]
|
||||||
|
|
||||||
|
extensions = ['sphinxcontrib.ditaa']
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
#
|
#
|
||||||
|
@@ -2,14 +2,21 @@ FROM alpine:3.8
|
|||||||
|
|
||||||
COPY makeSphinx.sh /makeSphinx.sh
|
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 --upgrade --no-cache-dir pip \
|
||||||
&& pip3 install --no-cache-dir \
|
&& pip3 install --no-cache-dir \
|
||||||
sphinx===1.8.3 \
|
sphinx===1.8.3 \
|
||||||
sphinx_rtd_theme===0.4.2 \
|
sphinx_rtd_theme===0.4.2 \
|
||||||
recommonmark===0.5.0 \
|
recommonmark===0.5.0 \
|
||||||
sphinx_autobuild===0.7.1 \
|
sphinx_autobuild===0.7.1 \
|
||||||
|
sphinxcontrib-ditaa===0.6 \
|
||||||
&& chmod 755 /makeSphinx.sh
|
&& 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
|
VOLUME /data-in /data-out
|
||||||
|
|
||||||
|
2
util/docker/doc.coreboot.org/ditaa.sh
Executable file
2
util/docker/doc.coreboot.org/ditaa.sh
Executable file
@@ -0,0 +1,2 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
exec java -jar /usr/lib/ditaa0_9.jar $*
|
Reference in New Issue
Block a user