source: doc/conf.py @ 3d8a6c0

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretch
Last change on this file since 3d8a6c0 was aec6ca8, checked in by Paul Brossier <piem@piem.org>, 3 years ago

doc/conf.py: do not rebuild included documents

  • Property mode set to 100644
File size: 8.2 KB
Line 
1# -*- coding: utf-8 -*-
2#
3# aubio documentation build configuration file, created by
4# sphinx-quickstart on Sun Jan 26 20:43:11 2014.
5#
6# This file is execfile()d with the current directory set to its containing dir.
7#
8# Note that not all possible configuration values are present in this
9# autogenerated file.
10#
11# All configuration values have a default; values that are commented out
12# serve to show the default.
13
14import sys, os
15
16# get version using this_version.py
17sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
18from this_version import get_aubio_version
19
20# If extensions (or modules to document with autodoc) are in another directory,
21# add these directories to sys.path here. If the directory is relative to the
22# documentation root, use os.path.abspath to make it absolute, like shown here.
23#sys.path.insert(0, os.path.abspath('../../python/build/...'))
24
25# -- General configuration -----------------------------------------------------
26
27# If your documentation needs a minimal Sphinx version, state it here.
28#needs_sphinx = '1.0'
29
30# Add any Sphinx extension module names here, as strings. They can be extensions
31# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
32extensions = ['sphinx.ext.viewcode', 'sphinx.ext.autodoc']
33
34# Add any paths that contain templates here, relative to this directory.
35templates_path = ['_templates']
36
37# The suffix of source filenames.
38source_suffix = '.rst'
39
40# The encoding of source files.
41#source_encoding = 'utf-8-sig'
42
43# The master toctree document.
44master_doc = 'index'
45
46# General information about the project.
47project = u'aubio'
48copyright = u'2016, Paul Brossier'
49
50# The version info for the project you're documenting, acts as replacement for
51# |version| and |release|, also used in various other places throughout the
52# built documents.
53#
54# The short X.Y version.
55
56version = get_aubio_version()[:3]
57# The full version, including alpha/beta/rc tags.
58release = get_aubio_version()
59
60# The language for content autogenerated by Sphinx. Refer to documentation
61# for a list of supported languages.
62#language = None
63
64# There are two options for replacing |today|: either, you set today to some
65# non-false value, then it is used:
66#today = ''
67# Else, today_fmt is used as the format for a strftime call.
68#today_fmt = '%B %d, %Y'
69
70# List of patterns, relative to source directory, that match files and
71# directories to ignore when looking for source files.
72exclude_patterns = ['_build',
73        'statuslinks.rst',
74        'download.rst',
75        'binaries.rst',
76        'debian_packages.rst',
77        'building.rst',
78        'android.rst',
79        'xcode_frameworks.rst',
80        'requirements.rst',
81        'cli_features.rst',
82        ]
83
84# The reST default role (used for this markup: `text`) to use for all documents.
85#default_role = None
86
87# If true, '()' will be appended to :func: etc. cross-reference text.
88#add_function_parentheses = True
89
90# If true, the current module name will be prepended to all description
91# unit titles (such as .. function::).
92#add_module_names = True
93
94# If true, sectionauthor and moduleauthor directives will be shown in the
95# output. They are ignored by default.
96#show_authors = False
97
98# The name of the Pygments (syntax highlighting) style to use.
99pygments_style = 'colorful'
100
101# A list of ignored prefixes for module index sorting.
102modindex_common_prefix = ['aubio.']
103
104
105# -- Options for HTML output ---------------------------------------------------
106
107# The theme to use for HTML and HTML Help pages.  See the documentation for
108# a list of builtin themes.
109#html_theme = 'agogo'
110#html_theme = 'default'
111#html_theme = 'haiku'
112html_theme = 'pyramid'
113
114# Theme options are theme-specific and customize the look and feel of a theme
115# further.  For a list of options available for each theme, see the
116# documentation.
117#html_theme_options = {}
118
119# Add any paths that contain custom themes here, relative to this directory.
120#html_theme_path = []
121
122# The name for this set of Sphinx documents.  If None, it defaults to
123# "<project> v<release> documentation".
124#html_title = None
125
126# A shorter title for the navigation bar.  Default is the same as html_title.
127#html_short_title = None
128
129# The name of an image file (relative to this directory) to place at the top
130# of the sidebar.
131#html_logo = None
132
133# The name of an image file (within the static path) to use as favicon of the
134# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
135# pixels large.
136#html_favicon = None
137
138# Add any paths that contain custom static files (such as style sheets) here,
139# relative to this directory. They are copied after the builtin static files,
140# so a file named "default.css" will overwrite the builtin "default.css".
141html_static_path = [] #['_static']
142
143# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
144# using the given strftime format.
145#html_last_updated_fmt = '%b %d, %Y'
146
147# If true, SmartyPants will be used to convert quotes and dashes to
148# typographically correct entities.
149#html_use_smartypants = True
150
151# Custom sidebar templates, maps document names to template names.
152#html_sidebars = {}
153
154# Additional templates that should be rendered to pages, maps page names to
155# template names.
156#html_additional_pages = {}
157
158# If false, no module index is generated.
159#html_domain_indices = True
160
161# If false, no index is generated.
162#html_use_index = True
163
164# If true, the index is split into individual pages for each letter.
165#html_split_index = False
166
167# If true, links to the reST sources are added to the pages.
168#html_show_sourcelink = True
169
170# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
171html_show_sphinx = False
172
173# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
174#html_show_copyright = True
175
176# If true, an OpenSearch description file will be output, and all pages will
177# contain a <link> tag referring to it.  The value of this option must be the
178# base URL from which the finished HTML is served.
179#html_use_opensearch = ''
180
181# This is the file name suffix for HTML files (e.g. ".xhtml").
182#html_file_suffix = None
183
184# Output file base name for HTML help builder.
185htmlhelp_basename = 'aubiodoc'
186
187
188# -- Options for LaTeX output --------------------------------------------------
189
190latex_elements = {
191# The paper size ('letterpaper' or 'a4paper').
192#'papersize': 'letterpaper',
193
194# The font size ('10pt', '11pt' or '12pt').
195#'pointsize': '10pt',
196
197# Additional stuff for the LaTeX preamble.
198#'preamble': '',
199}
200
201# Grouping the document tree into LaTeX files. List of tuples
202# (source start file, target name, title, author, documentclass [howto/manual]).
203latex_documents = [
204  ('index', 'aubio.tex', u'aubio Documentation',
205   u'Paul Brossier', 'manual'),
206]
207
208# The name of an image file (relative to this directory) to place at the top of
209# the title page.
210#latex_logo = None
211
212# For "manual" documents, if this is true, then toplevel headings are parts,
213# not chapters.
214#latex_use_parts = False
215
216# If true, show page references after internal links.
217#latex_show_pagerefs = False
218
219# If true, show URL addresses after external links.
220#latex_show_urls = False
221
222# Documents to append as an appendix to all manuals.
223#latex_appendices = []
224
225# If false, no module index is generated.
226#latex_domain_indices = True
227
228
229# -- Options for manual page output --------------------------------------------
230
231# One entry per manual page. List of tuples
232# (source start file, name, description, authors, manual section).
233man_pages = [
234    ('index', 'aubio', u'aubio Documentation',
235     [u'Paul Brossier'], 1)
236]
237
238# If true, show URL addresses after external links.
239#man_show_urls = False
240
241
242# -- Options for Texinfo output ------------------------------------------------
243
244# Grouping the document tree into Texinfo files. List of tuples
245# (source start file, target name, title, author,
246#  dir menu entry, description, category)
247texinfo_documents = [
248  ('index', 'aubio', u'aubio Documentation',
249   u'Paul Brossier', 'aubio', 'One line description of project.',
250   'Miscellaneous'),
251]
252
253# Documents to append as an appendix to all manuals.
254#texinfo_appendices = []
255
256# If false, no module index is generated.
257#texinfo_domain_indices = True
258
259# How to display URL addresses: 'footnote', 'no', or 'inline'.
260#texinfo_show_urls = 'footnote'
261
262def setup(app):
263    if release.endswith('~alpha'): app.tags.add('devel')
Note: See TracBrowser for help on using the repository browser.