Documentation: Remove ditaa support
Ditaa is a utility to convert ascii block diagrams into bitmap graphics. The latest sphinx-contrib-ditaa extension has not been updated since 2022 [1] and does not declare whether it is safe for parallel reading, causing sphinx to issue a warning as we use the `-j auto` flag to parallelize the build. It doesn't seem like anyone ever used it in the docs aside from a now abandoned patch [2], so just remove it. [1] https://pypi.org/project/sphinxcontrib-ditaa/ [2] https://review.coreboot.org/c/coreboot/+/37643 Change-Id: I460ce24aab203cbb416888787fc6e2c613d306b3 Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/84887 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
This commit is contained in:
parent
b6f3ee3f8f
commit
d95d9f8ce8
4 changed files with 1 additions and 19 deletions
|
|
@ -31,14 +31,6 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# Try to load DITAA
|
||||
try:
|
||||
import sphinxcontrib.ditaa
|
||||
except ImportError:
|
||||
print("Error: Please install sphinxcontrib.ditaa for ASCII art conversion\n")
|
||||
else:
|
||||
extensions += ['sphinxcontrib.ditaa']
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
|
|
|
|||
|
|
@ -49,10 +49,9 @@ modules:
|
|||
* sphinx
|
||||
* recommonmark
|
||||
* sphinx_rtd_theme
|
||||
* sphinxcontrib-ditaa
|
||||
|
||||
The following combination of versions has been tested: sphinx 2.3.1,
|
||||
recommonmark 0.6.0, sphinx_rtd_theme 0.4.3 and sphinxcontrib-ditaa 0.7.
|
||||
recommonmark 0.6.0, and sphinx_rtd_theme 0.4.3.
|
||||
|
||||
Now change into the `Documentation` folder in the coreboot directory and run
|
||||
this command in there
|
||||
|
|
|
|||
|
|
@ -9,7 +9,6 @@ RUN \
|
|||
make \
|
||||
bash \
|
||||
git \
|
||||
openjdk8-jre \
|
||||
ttf-dejavu \
|
||||
fontconfig \
|
||||
&& chmod 755 /makeSphinx.sh
|
||||
|
|
@ -29,15 +28,9 @@ RUN \
|
|||
jinja2==3.1.3 \
|
||||
myst-parser==2.0.0 \
|
||||
sphinx===7.2.6 \
|
||||
sphinxcontrib-ditaa===1.0.2 \
|
||||
sphinx_autobuild===2024.2.4 \
|
||||
sphinx_rtd_theme===2.0.0
|
||||
|
||||
ADD https://github.com/stathissideris/ditaa/releases/download/v0.11.0/ditaa-0.11.0-standalone.jar \
|
||||
/usr/lib/ditaa-0.11.0-standalone.jar
|
||||
|
||||
ADD ditaa.sh /usr/bin/ditaa
|
||||
|
||||
VOLUME /data-in /data-out
|
||||
|
||||
# For Sphinx-autobuild
|
||||
|
|
|
|||
|
|
@ -1,2 +0,0 @@
|
|||
#!/usr/bin/env sh
|
||||
exec java -jar /usr/lib/ditaa-0.11.0-standalone.jar $*
|
||||
Loading…
Add table
Add a link
Reference in a new issue