From d95d9f8ce82988abd0dce010cbdd3c567508196f Mon Sep 17 00:00:00 2001 From: Nicholas Chin Date: Sun, 27 Oct 2024 17:09:39 -0600 Subject: 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 Reviewed-on: https://review.coreboot.org/c/coreboot/+/84887 Reviewed-by: Felix Singer Tested-by: build bot (Jenkins) --- Documentation/getting_started/writing_documentation.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'Documentation/getting_started/writing_documentation.md') diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md index b9c30b00d3..6b1cf3ceb5 100644 --- a/Documentation/getting_started/writing_documentation.md +++ b/Documentation/getting_started/writing_documentation.md @@ -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 -- cgit v1.2.3