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 12# -- Project information ----------------------------------------------------- 13 14project = 'Trusted Firmware-A' 15 16version = '2.1' 17release = version # We don't need these to be distinct 18 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 27# Add any paths that contain templates here, relative to this directory. 28templates_path = ['_templates'] 29 30# The suffix(es) of source filenames. 31source_suffix = '.rst' 32 33# The master toctree document. 34master_doc = 'index' 35 36# The language for content autogenerated by Sphinx. Refer to documentation 37# for a list of supported languages. 38# 39# This is also used if you do content translation via gettext catalogs. 40# Usually you set "language" from the command line for these cases. 41language = None 42 43# List of patterns, relative to source directory, that match files and 44# directories to ignore when looking for source files. 45# This pattern also affects html_static_path and html_extra_path . 46exclude_patterns = [] 47 48# The name of the Pygments (syntax highlighting) style to use. 49pygments_style = 'sphinx' 50 51 52# -- Options for HTML output ------------------------------------------------- 53 54# Don't show the "Built with Sphinx" footer 55html_show_sphinx = False 56 57# Don't show copyright info in the footer (we have this content in the page) 58html_show_copyright = False 59 60# The theme to use for HTML and HTML Help pages. See the documentation for 61# a list of builtin themes. 62html_theme = "sphinx_rtd_theme" 63 64# The logo to display in the sidebar 65html_logo = 'resources/TrustedFirmware-Logo_standard-white.png' 66 67# Options for the "sphinx-rtd-theme" theme 68html_theme_options = { 69 'collapse_navigation': False, # Can expand and collapse sidebar entries 70 'prev_next_buttons_location': 'both', # Top and bottom of the page 71 'style_external_links': True # Display an icon next to external links 72} 73
