1# -*- coding: utf-8 -*- 2# 3# Copyright (c) 2019, 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 18version = '2.1' 19release = version # We don't need these to be distinct 20 21# -- General configuration --------------------------------------------------- 22 23# Add any Sphinx extension module names here, as strings. They can be 24# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 25# ones. 26extensions = ['sphinx.ext.autosectionlabel', 'sphinxcontrib.plantuml'] 27 28# Add any paths that contain templates here, relative to this directory. 29templates_path = ['_templates'] 30 31# The suffix(es) of source filenames. 32source_suffix = '.rst' 33 34# The master toctree document. 35master_doc = 'index' 36 37# The language for content autogenerated by Sphinx. Refer to documentation 38# for a list of supported languages. 39# 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. 42language = None 43 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 . 47exclude_patterns = [] 48 49# The name of the Pygments (syntax highlighting) style to use. 50pygments_style = 'sphinx' 51 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. 54with open('global_substitutions.txt', 'r') as subs: 55 rst_prolog = subs.read() 56 57# Minimum version of sphinx required 58needs_sphinx = '2.0' 59 60# -- Options for HTML output ------------------------------------------------- 61 62# Don't show the "Built with Sphinx" footer 63html_show_sphinx = False 64 65# Don't show copyright info in the footer (we have this content in the page) 66html_show_copyright = False 67 68# The theme to use for HTML and HTML Help pages. See the documentation for 69# a list of builtin themes. 70html_theme = "sphinx_rtd_theme" 71 72# The logo to display in the sidebar 73html_logo = 'resources/TrustedFirmware-Logo_standard-white.png' 74 75# Options for the "sphinx-rtd-theme" theme 76html_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 80} 81 82# -- Options for autosectionlabel -------------------------------------------- 83 84# Only generate automatic section labels for document titles 85autosectionlabel_maxdepth = 1 86 87# -- Options for plantuml ---------------------------------------------------- 88 89plantuml_output_format = 'svg_img' 90
