blob: 345f53bea4b21c847ff960f5ad266e1ff83d369c [file] [log] [blame]
Paul Beesley22994f72019-01-23 15:39:39 +00001# -*- coding: utf-8 -*-
2#
Harrison Mutai32df52d2023-06-05 12:26:28 +01003# Copyright (c) 2019-2023, Arm Limited. All rights reserved.
Paul Beesley22994f72019-01-23 15:39:39 +00004#
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
Paul Beesley606d8072019-03-13 13:58:02 +000012
Paul Beesley22994f72019-01-23 15:39:39 +000013# -- Project information -----------------------------------------------------
14
Harrison Mutai32df52d2023-06-05 12:26:28 +010015project = "Trusted Firmware-A"
Harrison Mutaifa9b14d2023-05-31 10:18:49 +010016author = "Trusted Firmware-A contributors"
17version = "2.9.0"
18release = "2.9.0"
Paul Beesley22994f72019-01-23 15:39:39 +000019
Paul Beesley22994f72019-01-23 15:39:39 +000020# -- 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.
Harrison Mutaifa9b14d2023-05-31 10:18:49 +010025extensions = [
26 "myst_parser",
27 "sphinx.ext.autosectionlabel",
28 "sphinxcontrib.plantuml",
29 "sphinxcontrib.inkscapeconverter",
30]
Paul Beesley22994f72019-01-23 15:39:39 +000031
32# Add any paths that contain templates here, relative to this directory.
Harrison Mutai32df52d2023-06-05 12:26:28 +010033templates_path = ["_templates"]
Paul Beesley22994f72019-01-23 15:39:39 +000034
35# The suffix(es) of source filenames.
Harrison Mutai32df52d2023-06-05 12:26:28 +010036source_suffix = [".md", ".rst"]
Paul Beesley22994f72019-01-23 15:39:39 +000037
38# The master toctree document.
Harrison Mutai32df52d2023-06-05 12:26:28 +010039master_doc = "index"
Paul Beesley22994f72019-01-23 15:39:39 +000040
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.
Boyan Karatotev39dea252022-10-27 11:56:40 +010046language = "en"
Paul Beesley22994f72019-01-23 15:39:39 +000047
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 .
Boyan Karatotev4273e6b2022-10-27 11:28:23 +010051# Don't try to build the venv in case it's placed with the sources
52exclude_patterns = [".env", "env", ".venv", "venv"]
Paul Beesley22994f72019-01-23 15:39:39 +000053
54# The name of the Pygments (syntax highlighting) style to use.
Harrison Mutai32df52d2023-06-05 12:26:28 +010055pygments_style = "sphinx"
Paul Beesley22994f72019-01-23 15:39:39 +000056
Paul Beesley606d8072019-03-13 13:58:02 +000057# Load the contents of the global substitutions file into the 'rst_prolog'
Harrison Mutaifa9b14d2023-05-31 10:18:49 +010058# variable. This ensures that the substitutions are all inserted into each
59# page.
Harrison Mutai32df52d2023-06-05 12:26:28 +010060with open("global_substitutions.txt", "r") as subs:
61 rst_prolog = subs.read()
Paul Beesley22994f72019-01-23 15:39:39 +000062
Paul Beesley73e4bd72019-05-17 11:45:36 +010063# Minimum version of sphinx required
Harrison Mutai32df52d2023-06-05 12:26:28 +010064needs_sphinx = "2.0"
Paul Beesley73e4bd72019-05-17 11:45:36 +010065
Paul Beesley22994f72019-01-23 15:39:39 +000066# -- Options for HTML output -------------------------------------------------
67
68# Don't show the "Built with Sphinx" footer
69html_show_sphinx = False
70
71# Don't show copyright info in the footer (we have this content in the page)
72html_show_copyright = False
73
74# The theme to use for HTML and HTML Help pages. See the documentation for
75# a list of builtin themes.
76html_theme = "sphinx_rtd_theme"
77
78# The logo to display in the sidebar
Harrison Mutai32df52d2023-06-05 12:26:28 +010079html_logo = "resources/TrustedFirmware-Logo_standard-white.png"
Paul Beesley22994f72019-01-23 15:39:39 +000080
81# Options for the "sphinx-rtd-theme" theme
82html_theme_options = {
Harrison Mutai32df52d2023-06-05 12:26:28 +010083 "collapse_navigation": False, # Can expand and collapse sidebar entries
84 "prev_next_buttons_location": "both", # Top and bottom of the page
85 "style_external_links": True, # Display an icon next to external links
Paul Beesley22994f72019-01-23 15:39:39 +000086}
Paul Beesley73e4bd72019-05-17 11:45:36 +010087
Zelalem05fed522021-02-24 19:20:09 -060088# Path to _static directory
Harrison Mutai32df52d2023-06-05 12:26:28 +010089html_static_path = ["_static"]
Zelalem05fed522021-02-24 19:20:09 -060090
91# Path to css file relative to html_static_path
92html_css_files = [
Harrison Mutai32df52d2023-06-05 12:26:28 +010093 "css/custom.css",
Zelalem05fed522021-02-24 19:20:09 -060094]
95
Paul Beesley73e4bd72019-05-17 11:45:36 +010096# -- Options for autosectionlabel --------------------------------------------
97
98# Only generate automatic section labels for document titles
Paul Beesley8c178b52019-07-12 11:56:58 +010099autosectionlabel_maxdepth = 1
100
101# -- Options for plantuml ----------------------------------------------------
102
Harrison Mutai32df52d2023-06-05 12:26:28 +0100103plantuml_output_format = "svg_img"
Harrison Mutaifa9b14d2023-05-31 10:18:49 +0100104
105# -- Options for latexmk ----------------------------------------------------
106
107latex_engine = "xelatex"
108latex_elements = {
109 "maxlistdepth": "10",
110 "pointsize": "11pt",
111}