1*653279b0SPaul Beesley# -*- coding: utf-8 -*- 2*653279b0SPaul Beesley# 3*653279b0SPaul Beesley# Copyright (c) 2019, Arm Limited. All rights reserved. 4*653279b0SPaul Beesley# 5*653279b0SPaul Beesley# SPDX-License-Identifier: BSD-3-Clause 6*653279b0SPaul Beesley# 7*653279b0SPaul Beesley# 8*653279b0SPaul Beesley# Configuration file for the Sphinx documentation builder. 9*653279b0SPaul Beesley# 10*653279b0SPaul Beesley# See the options documentation at http://www.sphinx-doc.org/en/master/config 11*653279b0SPaul Beesley 12*653279b0SPaul Beesley# -- Project information ----------------------------------------------------- 13*653279b0SPaul Beesley 14*653279b0SPaul Beesleyproject = 'Trusted Firmware-A' 15*653279b0SPaul Beesley 16*653279b0SPaul Beesleyversion = '2.1' 17*653279b0SPaul Beesleyrelease = version # We don't need these to be distinct 18*653279b0SPaul Beesley 19*653279b0SPaul Beesley 20*653279b0SPaul Beesley# -- General configuration --------------------------------------------------- 21*653279b0SPaul Beesley 22*653279b0SPaul Beesley# Add any Sphinx extension module names here, as strings. They can be 23*653279b0SPaul Beesley# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 24*653279b0SPaul Beesley# ones. 25*653279b0SPaul Beesleyextensions = [] 26*653279b0SPaul Beesley 27*653279b0SPaul Beesley# Add any paths that contain templates here, relative to this directory. 28*653279b0SPaul Beesleytemplates_path = ['_templates'] 29*653279b0SPaul Beesley 30*653279b0SPaul Beesley# The suffix(es) of source filenames. 31*653279b0SPaul Beesleysource_suffix = '.rst' 32*653279b0SPaul Beesley 33*653279b0SPaul Beesley# The master toctree document. 34*653279b0SPaul Beesleymaster_doc = 'index' 35*653279b0SPaul Beesley 36*653279b0SPaul Beesley# The language for content autogenerated by Sphinx. Refer to documentation 37*653279b0SPaul Beesley# for a list of supported languages. 38*653279b0SPaul Beesley# 39*653279b0SPaul Beesley# This is also used if you do content translation via gettext catalogs. 40*653279b0SPaul Beesley# Usually you set "language" from the command line for these cases. 41*653279b0SPaul Beesleylanguage = None 42*653279b0SPaul Beesley 43*653279b0SPaul Beesley# List of patterns, relative to source directory, that match files and 44*653279b0SPaul Beesley# directories to ignore when looking for source files. 45*653279b0SPaul Beesley# This pattern also affects html_static_path and html_extra_path . 46*653279b0SPaul Beesleyexclude_patterns = [] 47*653279b0SPaul Beesley 48*653279b0SPaul Beesley# The name of the Pygments (syntax highlighting) style to use. 49*653279b0SPaul Beesleypygments_style = 'sphinx' 50*653279b0SPaul Beesley 51*653279b0SPaul Beesley 52*653279b0SPaul Beesley# -- Options for HTML output ------------------------------------------------- 53*653279b0SPaul Beesley 54*653279b0SPaul Beesley# Don't show the "Built with Sphinx" footer 55*653279b0SPaul Beesleyhtml_show_sphinx = False 56*653279b0SPaul Beesley 57*653279b0SPaul Beesley# Don't show copyright info in the footer (we have this content in the page) 58*653279b0SPaul Beesleyhtml_show_copyright = False 59*653279b0SPaul Beesley 60*653279b0SPaul Beesley# The theme to use for HTML and HTML Help pages. See the documentation for 61*653279b0SPaul Beesley# a list of builtin themes. 62*653279b0SPaul Beesleyhtml_theme = "sphinx_rtd_theme" 63*653279b0SPaul Beesley 64*653279b0SPaul Beesley# The logo to display in the sidebar 65*653279b0SPaul Beesleyhtml_logo = 'resources/TrustedFirmware-Logo_standard-white.png' 66*653279b0SPaul Beesley 67*653279b0SPaul Beesley# Options for the "sphinx-rtd-theme" theme 68*653279b0SPaul Beesleyhtml_theme_options = { 69*653279b0SPaul Beesley 'collapse_navigation': False, # Can expand and collapse sidebar entries 70*653279b0SPaul Beesley 'prev_next_buttons_location': 'both', # Top and bottom of the page 71*653279b0SPaul Beesley 'style_external_links': True # Display an icon next to external links 72*653279b0SPaul Beesley} 73
