diff options
| author | Nicholas Chin <nic.c3.14@gmail.com> | 2024-10-27 17:09:39 -0600 |
|---|---|---|
| committer | Felix Singer <service+coreboot-gerrit@felixsinger.de> | 2024-10-27 23:51:03 +0000 |
| commit | d95d9f8ce82988abd0dce010cbdd3c567508196f (patch) | |
| tree | c3a178a7971a6334c4afd19f0f72d3af48c2eb26 /Documentation/getting_started | |
| parent | b6f3ee3f8f79fc4f07515f275442128dad9d8ce9 (diff) | |
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>
Diffstat (limited to 'Documentation/getting_started')
| -rw-r--r-- | Documentation/getting_started/writing_documentation.md | 3 |
1 files changed, 1 insertions, 2 deletions
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 |