| # 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 |
| |
| templates_path = ['_templates'] |
| 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. |
| # |
| # 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 |
| ] |