Documentation and top-level makefile updates
[tidl/tidl-api.git] / docs / source / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # OpenCL documentation build configuration file, created by
4 # sphinx-quickstart on Mon Jun 15 14:52:59 2015.
5 #
6 # This file is execfile()d with the current directory set to its
7 # containing dir.
8 #
9 # Note that not all possible configuration values are present in this
10 # autogenerated file.
11 #
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
15 import sys
16 import os
17 import shlex
19 # If extensions (or modules to document with autodoc) are in another directory,
20 # add these directories to sys.path here. If the directory is relative to the
21 # documentation root, use os.path.abspath to make it absolute, like shown here.
22 #sys.path.insert(0, os.path.abspath('.'))
24 # -- General configuration ------------------------------------------------
26 # If your documentation needs a minimal Sphinx version, state it here.
27 #needs_sphinx = '1.0'
29 # Add any Sphinx extension module names here, as strings. They can be
30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31 # ones.
32 extensions = [
33     'sphinx.ext.intersphinx',
34     'sphinx.ext.todo',
35     'sphinx.ext.mathjax',
36     'sphinx.ext.ifconfig',
37     'breathe',
38 ]
40 # Add any paths that contain templates here, relative to this directory.
41 templates_path = ['_templates']
43 # The suffix(es) of source filenames.
44 # You can specify multiple suffix as a list of string:
45 # source_suffix = ['.rst', '.md']
46 source_suffix = '.rst'
48 # The encoding of source files.
49 #source_encoding = 'utf-8-sig'
51 # The master toctree document.
52 master_doc = 'index'
54 # General information about the project.
55 project = u'TIDL API User\'s Guide'
56 copyright = u'2018, Texas Instruments Incorporated'
58 # The version info for the project you're documenting, acts as replacement for
59 # |version| and |release|, also used in various other places throughout the
60 # built documents.
61 #
62 # The short X.Y version.
63 version = '1.0'
64 # The full version, including alpha/beta/rc tags.
65 release = '1.0.0'
67 # The language for content autogenerated by Sphinx. Refer to documentation
68 # for a list of supported languages.
69 #
70 # This is also used if you do content translation via gettext catalogs.
71 # Usually you set "language" from the command line for these cases.
72 language = None
74 # There are two options for replacing |today|: either, you set today to some
75 # non-false value, then it is used:
76 #today = ''
77 # Else, today_fmt is used as the format for a strftime call.
78 #today_fmt = '%B %d, %Y'
80 # List of patterns, relative to source directory, that match files and
81 # directories to ignore when looking for source files.
82 exclude_patterns = []
84 # The reST default role (used for this markup: `text`) to use for all
85 # documents.
86 #default_role = None
88 # If true, '()' will be appended to :func: etc. cross-reference text.
89 #add_function_parentheses = True
91 # If true, the current module name will be prepended to all description
92 # unit titles (such as .. function::).
93 #add_module_names = True
95 # If true, sectionauthor and moduleauthor directives will be shown in the
96 # output. They are ignored by default.
97 #show_authors = False
99 # The name of the Pygments (syntax highlighting) style to use.
100 pygments_style = 'trac'
101 highlight_language = 'cpp'
102 numfig = True
104 # A list of ignored prefixes for module index sorting.
105 #modindex_common_prefix = []
107 # If true, keep warnings as "system message" paragraphs in the built documents.
108 #keep_warnings = False
110 # If true, `todo` and `todoList` produce output, else they produce nothing.
111 todo_include_todos = True
114 # -- Options for HTML output ----------------------------------------------
116 # The theme to use for HTML and HTML Help pages.  See the documentation for
117 # a list of builtin themes.
118 html_theme = 'sphinx_rtd_theme_ti'
120 # Theme options are theme-specific and customize the look and feel of a theme
121 # further.  For a list of options available for each theme, see the
122 # documentation.
123 #html_theme_options = {}
125 # Add any paths that contain custom themes here, relative to this directory.
126 html_theme_path = ["_themes"]
128 # The name for this set of Sphinx documents.  If None, it defaults to
129 # "<project> v<release> documentation".
130 html_title = 'TIDL API User\'s Guide'
132 # A shorter title for the navigation bar.  Default is the same as html_title.
133 #html_short_title = None
135 # The name of an image file (relative to this directory) to place at the top
136 # of the sidebar.
137 #html_logo = "images/ti_hz_2c_pos_rgbRev1.gif"
139 # The name of an image file (within the static path) to use as favicon of the
140 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
141 # pixels large.
142 html_favicon = 'images/tiicon.ico'
144 # Add any paths that contain custom static files (such as style sheets) here,
145 # relative to this directory. They are copied after the builtin static files,
146 # so a file named "default.css" will overwrite the builtin "default.css".
147 html_static_path = ['_static']
149 # Add any extra paths that contain custom files (such as robots.txt or
150 # .htaccess) here, relative to this directory. These files are copied
151 # directly to the root of the documentation.
152 #html_extra_path = []
154 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
155 # using the given strftime format.
156 html_last_updated_fmt = '%b %d, %Y'
158 # If true, SmartyPants will be used to convert quotes and dashes to
159 # typographically correct entities.
160 #html_use_smartypants = True
162 # Custom sidebar templates, maps document names to template names.
163 #html_sidebars = {}
165 # Additional templates that should be rendered to pages, maps page names to
166 # template names.
167 #html_additional_pages = {}
169 # If false, no module index is generated.
170 #html_domain_indices = True
172 # If false, no index is generated.
173 #html_use_index = True
175 # If true, the index is split into individual pages for each letter.
176 #html_split_index = False
178 # If true, links to the reST sources are added to the pages.
179 html_show_sourcelink = False
181 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
182 html_show_sphinx = False
184 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
185 #html_show_copyright = True
187 # If true, an OpenSearch description file will be output, and all pages will
188 # contain a <link> tag referring to it.  The value of this option must be the
189 # base URL from which the finished HTML is served.
190 #html_use_opensearch = ''
192 # This is the file name suffix for HTML files (e.g. ".xhtml").
193 #html_file_suffix = None
195 # Language to be used for generating the HTML full-text search index.
196 # Sphinx supports the following languages:
197 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
198 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
199 html_search_language = 'en'
201 # A dictionary with options for the search language support, empty by default.
202 # Now only 'ja' uses this config value
203 #html_search_options = {'type': 'default'}
205 # The name of a javascript file (relative to the configuration directory) that
206 # implements a search results scorer. If empty, the default will be used.
207 html_search_scorer = ''
209 # Output file base name for HTML help builder.
210 htmlhelp_basename = 'TIDLDoc'
212 # -- Options for LaTeX output ---------------------------------------------
214 latex_elements = {
215 # The paper size ('letterpaper' or 'a4paper').
216 #'papersize': 'letterpaper',
218 # The font size ('10pt', '11pt' or '12pt').
219 #'pointsize': '10pt',
221 # Additional stuff for the LaTeX preamble.
222 #'preamble': '',
225 # Grouping the document tree into LaTeX files. List of tuples
226 # (source start file, target name, title,
227 #  author, documentclass [howto, manual, or own class]).
228 latex_documents = [
229   (master_doc, 'TIDL.tex', u'TI Neural Network API Documentation',
230    u'Texas Instruments Incorporated', u'manual'),
233 # The name of an image file (relative to this directory) to place at the top of
234 # the title page.
235 #latex_logo = None
237 # For "manual" documents, if this is true, then toplevel headings are parts,
238 # not chapters.
239 #latex_use_parts = False
241 # If true, show page references after internal links.
242 #latex_show_pagerefs = False
244 # If true, show URL addresses after external links.
245 #latex_show_urls = False
247 # Documents to append as an appendix to all manuals.
248 #latex_appendices = []
250 # If false, no module index is generated.
251 #latex_domain_indices = True
254 # If true, show URL addresses after external links.
255 #man_show_urls = False
258 # Documents to append as an appendix to all manuals.
259 #texinfo_appendices = []
261 # If false, no module index is generated.
262 #texinfo_domain_indices = True
264 # How to display URL addresses: 'footnote', 'no', or 'inline'.
265 #texinfo_show_urls = 'footnote'
267 # If true, do not generate a @detailmenu in the "Top" node's menu.
268 #texinfo_no_detailmenu = False
271 # intersphinx mapping for OpenCL sphinx documentation
272 intersphinx_mapping = {'opencl' : ('http://downloads.ti.com/mctools/esd/docs/opencl/', None)}
274 def setup(app):
275     app.add_stylesheet("theme_overrides.css")
279 # -- Breathe extension to integrate doxygen output --
281 breathe_projects = {
282 "TIDL":"../../tidl_api/doxygen/xml/",