1# -*- coding: utf-8 -*-
2#
3# Copyright (c) 2019-2021, 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
12import os
13
14# -- Project information -----------------------------------------------------
15
16project = 'Trusted Firmware-A'
17
18# -- General configuration ---------------------------------------------------
19
20# Add any Sphinx extension module names here, as strings. They can be
21# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
22# ones.
23extensions = ['sphinx.ext.autosectionlabel', 'sphinxcontrib.plantuml']
24
25# Add any paths that contain templates here, relative to this directory.
26templates_path = ['_templates']
27
28# The suffix(es) of source filenames.
29source_suffix = '.rst'
30
31# The master toctree document.
32master_doc = 'index'
33
34# The language for content autogenerated by Sphinx. Refer to documentation
35# for a list of supported languages.
36#
37# This is also used if you do content translation via gettext catalogs.
38# Usually you set "language" from the command line for these cases.
39language = None
40
41# List of patterns, relative to source directory, that match files and
42# directories to ignore when looking for source files.
43# This pattern also affects html_static_path and html_extra_path .
44exclude_patterns = []
45
46# The name of the Pygments (syntax highlighting) style to use.
47pygments_style = 'sphinx'
48
49# Load the contents of the global substitutions file into the 'rst_prolog'
50# variable. This ensures that the substitutions are all inserted into each page.
51with open('global_substitutions.txt', 'r') as subs:
52  rst_prolog = subs.read()
53
54# Minimum version of sphinx required
55needs_sphinx = '2.0'
56
57# -- Options for HTML output -------------------------------------------------
58
59# Don't show the "Built with Sphinx" footer
60html_show_sphinx = False
61
62# Don't show copyright info in the footer (we have this content in the page)
63html_show_copyright = False
64
65# The theme to use for HTML and HTML Help pages.  See the documentation for
66# a list of builtin themes.
67html_theme = "sphinx_rtd_theme"
68
69# The logo to display in the sidebar
70html_logo = 'resources/TrustedFirmware-Logo_standard-white.png'
71
72# Options for the "sphinx-rtd-theme" theme
73html_theme_options = {
74    'collapse_navigation': False, # Can expand and collapse sidebar entries
75    'prev_next_buttons_location': 'both', # Top and bottom of the page
76    'style_external_links': True # Display an icon next to external links
77}
78
79# Path to _static directory
80html_static_path = ['_static']
81
82# Path to css file relative to html_static_path
83html_css_files = [
84    'css/custom.css',
85]
86
87# -- Options for autosectionlabel --------------------------------------------
88
89# Only generate automatic section labels for document titles
90autosectionlabel_maxdepth = 1
91
92# -- Options for plantuml ----------------------------------------------------
93
94plantuml_output_format = 'svg_img'
95