mirror of
https://github.com/Dasharo/coreboot.git
synced 2026-03-06 14:43:26 -08:00
d95d9f8ce8
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>
49 lines
1.6 KiB
Python
49 lines
1.6 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
import subprocess
|
|
|
|
project = 'coreboot'
|
|
copyright = 'CC-by 4.0 the coreboot project'
|
|
author = 'the coreboot project'
|
|
|
|
release = subprocess.check_output(('git', 'describe')).decode("utf-8")
|
|
# The short X.Y version.
|
|
version = release.split("-")[0]
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = ["myst_parser"]
|
|
|
|
myst_heading_anchors = 5
|
|
myst_url_schemes = ["http", "https", "mailto", "ftp", "ircs"]
|
|
|
|
templates_path = ['_templates']
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
# Usually you set "language" from the command line for these cases.
|
|
language = 'en'
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_static_path = ['_static']
|
|
html_css_files = [
|
|
'theme_overrides.css', # override wide tables in RTD theme
|
|
]
|