Patrick Georgi has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/37646 )
Change subject: Documentation: enable ditaa integration ......................................................................
Documentation: enable ditaa integration
For prettier diagrams: http://ditaa.sourceforge.net/
Change-Id: Ic28dc5ea9d82ff6bf8654e2e33e675a536348654 Signed-off-by: Patrick Georgi pgeorgi@google.com --- M Documentation/conf.py M util/docker/doc.coreboot.org/Dockerfile 2 files changed, 10 insertions(+), 1 deletion(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/46/37646/1
diff --git a/Documentation/conf.py b/Documentation/conf.py index 85df9ea..8848ee6 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -25,6 +25,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 d05e8b5..23f5f50 100644 --- a/util/docker/doc.coreboot.org/Dockerfile +++ b/util/docker/doc.coreboot.org/Dockerfile @@ -2,14 +2,21 @@
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
Hello build bot (Jenkins), Martin Roth,
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/37646
to look at the new patch set (#2).
Change subject: Documentation: enable ditaa integration ......................................................................
Documentation: enable ditaa integration
For prettier diagrams: http://ditaa.sourceforge.net/
Change-Id: Ic28dc5ea9d82ff6bf8654e2e33e675a536348654 Signed-off-by: Patrick Georgi pgeorgi@google.com --- M Documentation/conf.py M util/docker/doc.coreboot.org/Dockerfile A util/docker/doc.coreboot.org/ditaa.sh 3 files changed, 12 insertions(+), 1 deletion(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/46/37646/2
Paul Menzel has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/37646 )
Change subject: Documentation: enable ditaa integration ......................................................................
Patch Set 2: Code-Review+1
Angel Pons has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/37646 )
Change subject: Documentation: enable ditaa integration ......................................................................
Patch Set 2: Code-Review+2
b-but w-what about the prettiness of pure ASCII art? ;-;
I guess not everyone uses a tiny bitmap font everywhere like I do :P
Patrick Georgi has submitted this change. ( https://review.coreboot.org/c/coreboot/+/37646 )
Change subject: Documentation: enable ditaa integration ......................................................................
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 --- M Documentation/conf.py M util/docker/doc.coreboot.org/Dockerfile A util/docker/doc.coreboot.org/ditaa.sh 3 files changed, 12 insertions(+), 1 deletion(-)
Approvals: build bot (Jenkins): Verified Paul Menzel: Looks good to me, but someone else must approve Angel Pons: Looks good to me, approved
diff --git a/Documentation/conf.py b/Documentation/conf.py index 85df9ea..8848ee6 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -25,6 +25,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 d05e8b5..23f5f50 100644 --- a/util/docker/doc.coreboot.org/Dockerfile +++ b/util/docker/doc.coreboot.org/Dockerfile @@ -2,14 +2,21 @@
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 0000000..5f27f53 --- /dev/null +++ b/util/docker/doc.coreboot.org/ditaa.sh @@ -0,0 +1,2 @@ +#!/bin/sh +exec java -jar /usr/lib/ditaa0_9.jar $*
Patrick Georgi has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/37646 )
Change subject: Documentation: enable ditaa integration ......................................................................
Patch Set 3:
Patch Set 2: Code-Review+2
b-but w-what about the prettiness of pure ASCII art? ;-;
I guess not everyone uses a tiny bitmap font everywhere like I do :P
There are some diagrams already in the docs that exist only as dia files (for editing) and svg (for presentations). While ditaa doesn't support the kind of diagram used there very well (memory layouts), I'd like to present an option that allows ascii art in the markdown that gets rendered to something "pretty" (YMMV).
There are more ascii art -> png renderers out there for other diagram styles, and if we find other suitable ones, I'm happy to add them, too, if that means that we can avoid SVG as source format.
-
Angel Pons (Code Review) -
Patrick Georgi (Code Review)
-
Paul Menzel (Code Review)