Documentation/conf.py

   1 # Configuration file for the Sphinx documentation builder.
   2 #
   3 # For the full list of built-in configuration values, see the documentation:
   4 # https://www.sphinx-doc.org/en/master/usage/configuration.html
   5
   6 # -- Project information -----------------------------------------------------
   7 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
   8
   9 import subprocess
  10
  11 project = 'coreboot'
  12 copyright = 'CC-by 4.0 the coreboot project'
  13 author = 'the coreboot project'
  14
  15 release = subprocess.check_output(('git', 'describe')).decode("utf-8")
  16 # The short X.Y version.
  17 version = release.split("-")[0]
  18
  19
  20 # -- General configuration ---------------------------------------------------
  21 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
  22
  23 extensions = ["myst_parser"]
  24
  25 myst_heading_anchors = 5
  26 myst_url_schemes = ["http", "https", "mailto", "ftp", "ircs"]
  27
  28 templates_path = ['_templates']
  29 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  30
  31 # The name of the Pygments (syntax highlighting) style to use.
  32 pygments_style = 'sphinx'
  33
  34 # Try to load DITAA
  35 try:
  36     import sphinxcontrib.ditaa
  37 except ImportError:
  38     print("Error: Please install sphinxcontrib.ditaa for ASCII art conversion\n")
  39 else:
  40     extensions += ['sphinxcontrib.ditaa']
  41
  42 # The language for content autogenerated by Sphinx. Refer to documentation
  43 # for a list of supported languages.
  44 #
  45 # This is also used if you do content translation via gettext catalogs.
  46 # Usually you set "language" from the command line for these cases.
  47 language = 'en'
  48
  49 # -- Options for HTML output -------------------------------------------------
  50 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
  51
  52 html_theme = 'sphinx_rtd_theme'
  53 html_static_path = ['_static']
  54 html_css_files = [
  55     'theme_overrides.css',  # override wide tables in RTD theme
  56 ]