blob: 1caebb23fc7e0f1911756f0978d80c74fb62007e [file] [log] [blame]
Gyorgy Szing74dae3c2018-09-27 17:00:46 +02001# -*- coding: utf-8 -*-
2#-------------------------------------------------------------------------------
3# Copyright (c) 2019, 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
15# -- Path setup --------------------------------------------------------------
16
17# If extensions (or modules to document with autodoc) are in another directory,
18# add these directories to sys.path here. If the directory is relative to the
19# documentation root, use os.path.abspath to make it absolute, like shown here.
20#
21import os
22import sys
23sys.path.insert(0, os.path.abspath('..'))
24sys.path.insert(0, os.path.abspath('../docs'))
25
26# -- Project information -----------------------------------------------------
27
28project = 'TF-M'
29copyright = '2017-2019, ARM CE-OSS'
30author = 'ARM CE-OSS'
31title = 'TF-M user Guide'
32
33# The short X.Y version
34version = '@SPHINXCFG_TFM_VERSION@'
35# The full version, including alpha/beta/rc tags
36release = '@SPHINXCFG_TFM_VERSION_FULL@'
37
38
39# -- General configuration ---------------------------------------------------
40
41# If your documentation needs a minimal Sphinx version, state it here.
42#
43# needs_sphinx = '1.0'
44
45# Add any Sphinx extension module names here, as strings. They can be
46# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
47# ones.
48extensions = [
49 'sphinx.ext.imgmath',
50 'm2r',
51]
52
53# Add any paths that contain templates here, relative to this directory.
54templates_path = ['_templates']
55
56# The suffix(es) of source filenames.
57# You can specify multiple suffix as a list of string:
58#
59source_suffix = ['.rst', '.md']
60
61# The master toctree document.
62master_doc = 'index'
63
64# The language for content autogenerated by Sphinx. Refer to documentation
65# for a list of supported languages.
66#
67# This is also used if you do content translation via gettext catalogs.
68# Usually you set "language" from the command line for these cases.
69language = None
70
71# List of patterns, relative to source directory, that match files and
72# directories to ignore when looking for source files.
73# This pattern also affects html_static_path and html_extra_path .
74exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
75
76# The name of the Pygments (syntax highlighting) style to use.
77pygments_style = 'sphinx'
78
79
80# -- Options for HTML output -------------------------------------------------
81
82# The theme to use for HTML and HTML Help pages. See the documentation for
83# a list of builtin themes.
84#
85html_theme = 'sphinx_rtd_theme'
86
87# Theme options are theme-specific and customize the look and feel of a theme
88# further. For a list of options available for each theme, see the
89# documentation.
90#
91# html_theme_options = {}
92
93# Add any paths that contain custom static files (such as style sheets) here,
94# relative to this directory. They are copied after the builtin static files,
95# so a file named "default.css" will overwrite the builtin "default.css".
96html_static_path = ['_static']
97
98# Custom sidebar templates, must be a dictionary that maps document names
99# to template names.
100#
101# The default sidebars (for documents that don't match any pattern) are
102# defined by theme itself. Builtin themes are using these templates by
103# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
104# 'searchbox.html']``.
105#
106# html_sidebars = {}
107
108#Disable adding conf.py copyright notice to HTML output
109html_show_copyright = False
110
111# -- Options for HTMLHelp output ---------------------------------------------
112
113# Output file base name for HTML help builder.
114htmlhelp_basename = 'TF-M doc'
115
116
117# -- Options for LaTeX output ------------------------------------------------
118
119latex_elements = {
120 # The paper size ('letterpaper' or 'a4paper').
121 #
122 # 'papersize': 'letterpaper',
123
124 # The font size ('10pt', '11pt' or '12pt').
125 #
126 # 'pointsize': '10pt',
127
128 # Additional stuff for the LaTeX preamble.
129 #
130 # 'preamble': '',
131
132 # Latex figure (float) alignment
133 #
134 # 'figure_align': 'htbp',
135}
136
137# Grouping the document tree into LaTeX files. List of tuples
138# (source start file, target name, title,
139# author, documentclass [howto, manual, or own class]).
140latex_documents = [
141 (master_doc, 'TF-M.tex', title,
142 author, 'manual'),
143]
144
145
146# -- Options for manual page output ------------------------------------------
147
148# One entry per manual page. List of tuples
149# (source start file, name, description, authors, manual section).
150#man_pages = [
151# (master_doc, 'tf-m', title,
152# [author], 7)
153#]
154
155
156# -- Options for Texinfo output ----------------------------------------------
157
158# Grouping the document tree into Texinfo files. List of tuples
159# (source start file, target name, title, author,
160# dir menu entry, description, category)
161#texinfo_documents = [
162# (master_doc, 'TF-M', title,
163# author, 'TF-M', 'Trusted Firmware for Cortex-M',
164# 'Miscellaneous'),
165#]
166
167
168# -- Extension configuration -------------------------------------------------