1# -*- coding: utf-8 -*- 2# 3# Copyright (c) 2019-2025, Arm Limited. All rights reserved. 4# 5# SPDX-License-Identifier: BSD-3-Clause 6# 7# 8# Configuration file for the Sphinx documentation builder. 9# 10# See the options documentation at http://www.sphinx-doc.org/en/master/config 11 12 13# -- Project information ----------------------------------------------------- 14 15project = "Trusted Firmware-A" 16author = "Trusted Firmware-A contributors" 17version = "2.14.0" 18release = "2.14.0" 19 20# -- General configuration --------------------------------------------------- 21 22# Add any Sphinx extension module names here, as strings. They can be 23# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 24# ones. 25extensions = [ 26 "myst_parser", 27 "sphinx.ext.autosectionlabel", 28 "sphinxcontrib.plantuml", 29 "sphinxcontrib.rsvgconverter", 30] 31 32# Add any paths that contain templates here, relative to this directory. 33templates_path = ["_templates"] 34 35# The suffix(es) of source filenames. 36source_suffix = [".md", ".rst"] 37 38# The master toctree document. 39master_doc = "index" 40 41# The language for content autogenerated by Sphinx. Refer to documentation 42# for a list of supported languages. 43# 44# This is also used if you do content translation via gettext catalogs. 45# Usually you set "language" from the command line for these cases. 46language = "en" 47 48# List of patterns, relative to source directory, that match files and 49# directories to ignore when looking for source files. 50# This pattern also affects html_static_path and html_extra_path . 51# Don't try to build the venv in case it's placed with the sources 52exclude_patterns = [".env", "env", ".venv", "venv"] 53 54linkcheck_anchors = False 55linkcheck_ignore = ["change-log.md"] 56 57# The name of the Pygments (syntax highlighting) style to use. 58pygments_style = "sphinx" 59 60# Load the contents of the global substitutions file into the 'rst_prolog' 61# variable. This ensures that the substitutions are all inserted into each 62# page. 63with open("global_substitutions.txt", "r") as subs: 64 rst_prolog = subs.read() 65 66# Minimum version of sphinx required 67needs_sphinx = "2.0" 68 69# -- Options for HTML output ------------------------------------------------- 70 71# Don't show the "Built with Sphinx" footer 72html_show_sphinx = False 73 74# Don't show copyright info in the footer (we have this content in the page) 75html_show_copyright = False 76 77# The theme to use for HTML and HTML Help pages. See the documentation for 78# a list of builtin themes. 79html_theme = "sphinx_rtd_theme" 80 81# The logo to display in the sidebar 82html_logo = "resources/TrustedFirmware-Logo_standard-white.png" 83 84# Options for the "sphinx-rtd-theme" theme 85html_theme_options = { 86 "collapse_navigation": False, # Can expand and collapse sidebar entries 87 "prev_next_buttons_location": "both", # Top and bottom of the page 88 "style_external_links": True, # Display an icon next to external links 89} 90 91# Path to _static directory 92html_static_path = ["_static"] 93 94# Path to css file relative to html_static_path 95html_css_files = [ 96 "css/custom.css", 97] 98 99# -- Options for autosectionlabel -------------------------------------------- 100 101# Only generate automatic section labels for document titles 102autosectionlabel_maxdepth = 1 103 104# -- Options for plantuml ---------------------------------------------------- 105 106plantuml_output_format = "svg_img" 107 108# -- Options for latexmk ---------------------------------------------------- 109 110latex_engine = "xelatex" 111latex_elements = { 112 "maxlistdepth": "10", 113 "pointsize": "11pt", 114 "extraclassoptions": "openany" 115} 116
