1# -*- coding: utf-8 -*-
2#-------------------------------------------------------------------------------
3# Copyright (c) 2019-2022, Arm Limited. All rights reserved.
4#
5# SPDX-License-Identifier: BSD-3-Clause
6#
7#-------------------------------------------------------------------------------
8
9# Configuration file for the Sphinx documentation builder.
10#
11# This file does only contain a selection of the most common options. For a
12# full list see the documentation:
13# http://www.sphinx-doc.org/en/master/config
14
15import os
16import sys
17import re
18from subprocess import check_output
19
20# -- Project information -----------------------------------------------------
21
22project = 'Trusted Firmware-M'
23copyright = '2017-2022, ARM CE-OSS'
24author = 'ARM CE-OSS'
25title = 'User Guide'
26
27# -- Extract current version -------------------------------------------------
28
29try:
30    vrex = re.compile(r'TF-M(?P<GIT_VERSION>v.+?)'
31                      r'(-[0-9]+-g)?(?P<GIT_SHA>[a-f0-9]{7,})?$')
32
33    version = check_output("git describe --tags --always",
34                            shell = True, encoding = 'UTF-8')
35
36    _v = vrex.match(version)
37    release = _v.group('GIT_VERSION')
38    if _v.group('GIT_SHA'):
39        version = release + "+" + _v.group('GIT_SHA')[:7]
40
41except:
42    version = release = 'Unknown'
43
44# -- General configuration ---------------------------------------------------
45
46extensions = [
47    'sphinx.ext.imgmath',
48    'm2r2', #Support markdown files. Needed for external code.
49    'sphinx.ext.autosectionlabel', #Make sphinx generate a label for each section
50    'sphinxcontrib.plantuml', #Add support for PlantUML drawings
51    'sphinxcontrib.rsvgconverter', #Add support for SVG to PDF
52    'sphinx_tabs.tabs', #Enable tab extension in Sphinx
53    'sphinx.ext.intersphinx', #Enable Intersphinx
54]
55
56intersphinx_mapping = {
57    "TF-M-Tests": ("https://trustedfirmware-m.readthedocs.io/projects/tf-m-tests/en/latest/", None),
58    "TF-M-Tools": ("https://trustedfirmware-m.readthedocs.io/projects/tf-m-tools/en/latest/", None),
59    "TF-M-Extras": ("https://trustedfirmware-m.readthedocs.io/projects/tf-m-extras/en/latest/", None),
60}
61
62intersphinx_disabled_reftypes = ["*"]
63
64# Make auto section labels generated be prefixed with file name.
65autosectionlabel_prefix_document=True
66# Add auto section label for level 2 headers only.
67autosectionlabel_maxdepth=2
68
69# Add any paths that contain templates here, relative to this directory.
70templates_path = ['_templates']
71
72# The suffix(es) of source filenames.
73# You can specify multiple suffix as a list of string:
74#
75source_suffix = ['.rst', '.md']
76
77# The master toctree document.
78master_doc = 'index'
79
80# The language for content autogenerated by Sphinx. Refer to documentation
81# for a list of supported languages.
82#
83# This is also used if you do content translation via gettext catalogs.
84# Usually you set "language" from the command line for these cases.
85language = None
86
87# List of patterns, relative to source directory, that match files and
88# directories to ignore when looking for source files.
89# This pattern also affects html_static_path and html_extra_path .
90exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'readme.rst',
91                    'platform/cypress/psoc64/security/keys/readme.rst',
92                    'lib/ext/**']
93
94# The name of the Pygments (syntax highlighting) style to use.
95pygments_style = 'sphinx'
96
97# -- Options for HTML output -------------------------------------------------
98
99html_theme = 'sphinx_rtd_theme'
100
101html_theme_options = {
102    'collapse_navigation' : False,
103    'prev_next_buttons_location' : None,   # Hide Prev and Next buttons
104    'display_version': True,    # Show version under logo
105    'sticky_navigation': True,
106    'navigation_depth': 3,
107}
108
109# Remove the "View page source" link from the top of docs pages
110html_show_sourcelink = False
111
112# Add any paths that contain custom static files (such as style sheets) here,
113# relative to configuration directory. They are copied after the builtin static
114# files, so a file named "default.css" will overwrite the builtin "default.css".
115html_static_path = ['_static']
116
117# Set the documentation logo relative to configuration directory
118html_logo = '_static/images/tf_logo_white.png'
119
120# Set the documentation favicon
121html_favicon = '_static/images/favicon.ico'
122
123#Disable adding conf.py copyright notice to HTML output
124html_show_copyright = False
125
126# Disable showing Sphinx footer message:
127# "Built with Sphinx using a theme provided by Read the Docs. "
128html_show_sphinx = False
129
130#Add custom css for HTML. Used to allow full page width rendering
131def setup(app):
132    app.add_css_file('css/tfm_custom.css')
133
134# -- Options for HTMLHelp output ---------------------------------------------
135
136# Output file base name for HTML help builder.
137htmlhelp_basename = 'TF-M doc'
138
139# Enable figures and tables auto numbering
140numfig = True
141numfig_secnum_depth = 0
142numfig_format = {
143    'figure': 'Figure %s:',
144    'table': 'Table %s:',
145    'code-block': 'Listing %s:',
146    'section': '%s'
147}
148
149# -- Options for LaTeX output ------------------------------------------------
150
151latex_elements = {
152    # 'papersize': 'letterpaper',
153    # 'pointsize': '10pt',
154    # 'preamble': '',
155    # 'figure_align': 'htbp',
156}
157
158# Grouping the document tree into LaTeX files. List of tuples
159# (source start file, target name, title,
160#  author, documentclass [howto, manual, or own class]).
161latex_documents = [
162    (master_doc, 'TF-M.tex', title,
163     author, 'manual'),
164]
165
166language = 'en'
167