1#!/usr/bin/env python3
2# -*- coding: utf-8 -*-
3#
4# tpm2-tss documentation build configuration file, created by
5# sphinx-quickstart on Thu Aug 29 14:00:06 2019.
6#
7# This file is execfile()d with the current directory set to its
8# containing dir.
9#
10# Note that not all possible configuration values are present in this
11# autogenerated file.
12#
13# All configuration values have a default; values that are commented out
14# serve to show the default.
15
16import subprocess
17
18# Create (unused) root file
19index_rst = open('index.rst', 'w')
20index_rst.write('.. toctree::\n   :maxdepth: 2')
21index_rst.close()
22
23# Build doxygen documentation
24subprocess.call(r"""
25        cd ..
26        version="master"
27        echo "Version: $version"
28        sed "s/@top_srcdir@/./g;
29             s/@top_builddir@/./g;
30             s/@PACKAGE_NAME@/tpm2-tss/g;
31             s/@VERSION@/$version/g" Doxyfile.in > Doxyfile
32        SRCDIR='.' PROJECT='tpm2-tss' VERSION='2.3.0-dev' PERL_PATH='/usr/bin/perl' HAVE_DOT='NO' GENERATE_MAN='YES' GENERATE_RTF='YES' GENERATE_XML='NO' GENERATE_HTMLHELP='NO' GENERATE_CHI='NO' GENERATE_HTML='YES' GENERATE_LATEX='NO' DOCDIR=doxygen-doc doxygen Doxyfile
33        cd sphinx
34    """, shell=True)
35
36# If extensions (or modules to document with autodoc) are in another directory,
37# add these directories to sys.path here. If the directory is relative to the
38# documentation root, use os.path.abspath to make it absolute, like shown here.
39#sys.path.insert(0, os.path.abspath('.'))
40
41# -- General configuration ------------------------------------------------
42
43# If your documentation needs a minimal Sphinx version, state it here.
44#needs_sphinx = '1.0'
45
46# Add any Sphinx extension module names here, as strings. They can be
47# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
48# ones.
49extensions = []
50
51# Add any paths that contain templates here, relative to this directory.
52templates_path = ['_templates']
53
54# The suffix(es) of source filenames.
55# You can specify multiple suffix as a list of string:
56# source_suffix = ['.rst', '.md']
57source_suffix = '.rst'
58
59# The encoding of source files.
60#source_encoding = 'utf-8-sig'
61
62# The master toctree document.
63master_doc = 'index'
64
65# General information about the project.
66project = 'tpm2-tss'
67copyright = '2019, open source community'
68author = 'open source community'
69
70# The version info for the project you're documenting, acts as replacement for
71# |version| and |release|, also used in various other places throughout the
72# built documents.
73#
74# The short X.Y version.
75version = ''
76# The full version, including alpha/beta/rc tags.
77release = ''
78
79# The language for content autogenerated by Sphinx. Refer to documentation
80# for a list of supported languages.
81#
82# This is also used if you do content translation via gettext catalogs.
83# Usually you set "language" from the command line for these cases.
84language = None
85
86# There are two options for replacing |today|: either, you set today to some
87# non-false value, then it is used:
88#today = ''
89# Else, today_fmt is used as the format for a strftime call.
90#today_fmt = '%B %d, %Y'
91
92# List of patterns, relative to source directory, that match files and
93# directories to ignore when looking for source files.
94exclude_patterns = ['_build']
95
96# The reST default role (used for this markup: `text`) to use for all
97# documents.
98#default_role = None
99
100# If true, '()' will be appended to :func: etc. cross-reference text.
101#add_function_parentheses = True
102
103# If true, the current module name will be prepended to all description
104# unit titles (such as .. function::).
105#add_module_names = True
106
107# If true, sectionauthor and moduleauthor directives will be shown in the
108# output. They are ignored by default.
109#show_authors = False
110
111# The name of the Pygments (syntax highlighting) style to use.
112pygments_style = 'sphinx'
113
114# A list of ignored prefixes for module index sorting.
115#modindex_common_prefix = []
116
117# If true, keep warnings as "system message" paragraphs in the built documents.
118#keep_warnings = False
119
120# If true, `todo` and `todoList` produce output, else they produce nothing.
121todo_include_todos = False
122
123
124# -- Options for HTML output ----------------------------------------------
125
126# The theme to use for HTML and HTML Help pages.  See the documentation for
127# a list of builtin themes.
128html_theme = 'alabaster'
129
130# Theme options are theme-specific and customize the look and feel of a theme
131# further.  For a list of options available for each theme, see the
132# documentation.
133#html_theme_options = {}
134
135# Add any paths that contain custom themes here, relative to this directory.
136#html_theme_path = []
137
138# The name for this set of Sphinx documents.  If None, it defaults to
139# "<project> v<release> documentation".
140#html_title = None
141
142# A shorter title for the navigation bar.  Default is the same as html_title.
143#html_short_title = None
144
145# The name of an image file (relative to this directory) to place at the top
146# of the sidebar.
147#html_logo = None
148
149# The name of an image file (relative to this directory) to use as a favicon of
150# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
151# pixels large.
152#html_favicon = None
153
154# Add any paths that contain custom static files (such as style sheets) here,
155# relative to this directory. They are copied after the builtin static files,
156# so a file named "default.css" will overwrite the builtin "default.css".
157html_static_path = ['_static']
158
159# Add any extra paths that contain custom files (such as robots.txt or
160# .htaccess) here, relative to this directory. These files are copied
161# directly to the root of the documentation.
162html_extra_path = ['../doxygen-doc/html']
163
164# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
165# using the given strftime format.
166#html_last_updated_fmt = '%b %d, %Y'
167
168# If true, SmartyPants will be used to convert quotes and dashes to
169# typographically correct entities.
170#html_use_smartypants = True
171
172# Custom sidebar templates, maps document names to template names.
173#html_sidebars = {}
174
175# Additional templates that should be rendered to pages, maps page names to
176# template names.
177#html_additional_pages = {}
178
179# If false, no module index is generated.
180#html_domain_indices = True
181
182# If false, no index is generated.
183#html_use_index = True
184
185# If true, the index is split into individual pages for each letter.
186#html_split_index = False
187
188# If true, links to the reST sources are added to the pages.
189#html_show_sourcelink = True
190
191# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
192#html_show_sphinx = True
193
194# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
195#html_show_copyright = True
196
197# If true, an OpenSearch description file will be output, and all pages will
198# contain a <link> tag referring to it.  The value of this option must be the
199# base URL from which the finished HTML is served.
200#html_use_opensearch = ''
201
202# This is the file name suffix for HTML files (e.g. ".xhtml").
203#html_file_suffix = None
204
205# Language to be used for generating the HTML full-text search index.
206# Sphinx supports the following languages:
207#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
208#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
209#html_search_language = 'en'
210
211# A dictionary with options for the search language support, empty by default.
212# Now only 'ja' uses this config value
213#html_search_options = {'type': 'default'}
214
215# The name of a javascript file (relative to the configuration directory) that
216# implements a search results scorer. If empty, the default will be used.
217#html_search_scorer = 'scorer.js'
218
219# Output file base name for HTML help builder.
220htmlhelp_basename = 'tpm2-tssdoc'
221
222# -- Options for LaTeX output ---------------------------------------------
223
224latex_elements = {
225# The paper size ('letterpaper' or 'a4paper').
226#'papersize': 'letterpaper',
227
228# The font size ('10pt', '11pt' or '12pt').
229#'pointsize': '10pt',
230
231# Additional stuff for the LaTeX preamble.
232#'preamble': '',
233
234# Latex figure (float) alignment
235#'figure_align': 'htbp',
236}
237
238# Grouping the document tree into LaTeX files. List of tuples
239# (source start file, target name, title,
240#  author, documentclass [howto, manual, or own class]).
241latex_documents = [
242    (master_doc, 'tpm2-tss.tex', 'tpm2-tss Documentation',
243     'open source community', 'manual'),
244]
245
246# The name of an image file (relative to this directory) to place at the top of
247# the title page.
248#latex_logo = None
249
250# For "manual" documents, if this is true, then toplevel headings are parts,
251# not chapters.
252#latex_use_parts = False
253
254# If true, show page references after internal links.
255#latex_show_pagerefs = False
256
257# If true, show URL addresses after external links.
258#latex_show_urls = False
259
260# Documents to append as an appendix to all manuals.
261#latex_appendices = []
262
263# If false, no module index is generated.
264#latex_domain_indices = True
265
266
267# -- Options for manual page output ---------------------------------------
268
269# One entry per manual page. List of tuples
270# (source start file, name, description, authors, manual section).
271man_pages = [
272    (master_doc, 'tpm2-tss', 'tpm2-tss Documentation',
273     [author], 1)
274]
275
276# If true, show URL addresses after external links.
277#man_show_urls = False
278
279
280# -- Options for Texinfo output -------------------------------------------
281
282# Grouping the document tree into Texinfo files. List of tuples
283# (source start file, target name, title, author,
284#  dir menu entry, description, category)
285texinfo_documents = [
286    (master_doc, 'tpm2-tss', 'tpm2-tss Documentation',
287     author, 'tpm2-tss', 'One line description of project.',
288     'Miscellaneous'),
289]
290
291# Documents to append as an appendix to all manuals.
292#texinfo_appendices = []
293
294# If false, no module index is generated.
295#texinfo_domain_indices = True
296
297# How to display URL addresses: 'footnote', 'no', or 'inline'.
298#texinfo_show_urls = 'footnote'
299
300# If true, do not generate a @detailmenu in the "Top" node's menu.
301#texinfo_no_detailmenu = False
302