1 # -*- coding: utf-8 -*-
3 # Copyright (c) 2019, Arm Limited. All rights reserved.
5 # SPDX-License-Identifier: BSD-3-Clause
8 # Configuration file for the Sphinx documentation builder.
10 # See the options documentation at http://www.sphinx-doc.org/en/master/config
14 # -- Project information -----------------------------------------------------
16 project
= 'Trusted Firmware-A'
19 release
= version
# We don't need these to be distinct
21 # -- General configuration ---------------------------------------------------
23 # Add any Sphinx extension module names here, as strings. They can be
24 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
26 extensions
= ['sphinx.ext.autosectionlabel', 'sphinxcontrib.plantuml']
28 # Add any paths that contain templates here, relative to this directory.
29 templates_path
= ['_templates']
31 # The suffix(es) of source filenames.
32 source_suffix
= '.rst'
34 # The master toctree document.
37 # The language for content autogenerated by Sphinx. Refer to documentation
38 # for a list of supported languages.
40 # This is also used if you do content translation via gettext catalogs.
41 # Usually you set "language" from the command line for these cases.
44 # List of patterns, relative to source directory, that match files and
45 # directories to ignore when looking for source files.
46 # This pattern also affects html_static_path and html_extra_path .
49 # The name of the Pygments (syntax highlighting) style to use.
50 pygments_style
= 'sphinx'
52 # Load the contents of the global substitutions file into the 'rst_prolog'
53 # variable. This ensures that the substitutions are all inserted into each page.
54 with
open('global_substitutions.txt', 'r') as subs
:
55 rst_prolog
= subs
.read()
57 # Minimum version of sphinx required
60 # -- Options for HTML output -------------------------------------------------
62 # Don't show the "Built with Sphinx" footer
63 html_show_sphinx
= False
65 # Don't show copyright info in the footer (we have this content in the page)
66 html_show_copyright
= False
68 # The theme to use for HTML and HTML Help pages. See the documentation for
69 # a list of builtin themes.
70 html_theme
= "sphinx_rtd_theme"
72 # The logo to display in the sidebar
73 html_logo
= 'resources/TrustedFirmware-Logo_standard-white.png'
75 # Options for the "sphinx-rtd-theme" theme
76 html_theme_options
= {
77 'collapse_navigation': False, # Can expand and collapse sidebar entries
78 'prev_next_buttons_location': 'both', # Top and bottom of the page
79 'style_external_links': True # Display an icon next to external links
82 # -- Options for autosectionlabel --------------------------------------------
84 # Only generate automatic section labels for document titles
85 autosectionlabel_maxdepth
= 1
87 # -- Options for plantuml ----------------------------------------------------
89 plantuml_output_format
= 'svg_img'