source: doc/conf.py @ 18373d8

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

doc/conf.py: use this_version here too

  • Property mode set to 100644
File size: 7.9 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
74# The reST default role (used for this markup: `text`) to use for all documents.
75#default_role = None
76
77# If true, '()' will be appended to :func: etc. cross-reference text.
78#add_function_parentheses = True
79
80# If true, the current module name will be prepended to all description
81# unit titles (such as .. function::).
82#add_module_names = True
83
84# If true, sectionauthor and moduleauthor directives will be shown in the
85# output. They are ignored by default.
86#show_authors = False
87
88# The name of the Pygments (syntax highlighting) style to use.
89pygments_style = 'colorful'
90
91# A list of ignored prefixes for module index sorting.
92modindex_common_prefix = ['aubio.']
93
94
95# -- Options for HTML output ---------------------------------------------------
96
97# The theme to use for HTML and HTML Help pages.  See the documentation for
98# a list of builtin themes.
99#html_theme = 'agogo'
100#html_theme = 'default'
101#html_theme = 'haiku'
102html_theme = 'pyramid'
103
104# Theme options are theme-specific and customize the look and feel of a theme
105# further.  For a list of options available for each theme, see the
106# documentation.
107#html_theme_options = {}
108
109# Add any paths that contain custom themes here, relative to this directory.
110#html_theme_path = []
111
112# The name for this set of Sphinx documents.  If None, it defaults to
113# "<project> v<release> documentation".
114#html_title = None
115
116# A shorter title for the navigation bar.  Default is the same as html_title.
117#html_short_title = None
118
119# The name of an image file (relative to this directory) to place at the top
120# of the sidebar.
121#html_logo = None
122
123# The name of an image file (within the static path) to use as favicon of the
124# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
125# pixels large.
126#html_favicon = None
127
128# Add any paths that contain custom static files (such as style sheets) here,
129# relative to this directory. They are copied after the builtin static files,
130# so a file named "default.css" will overwrite the builtin "default.css".
131html_static_path = [] #['_static']
132
133# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
134# using the given strftime format.
135#html_last_updated_fmt = '%b %d, %Y'
136
137# If true, SmartyPants will be used to convert quotes and dashes to
138# typographically correct entities.
139#html_use_smartypants = True
140
141# Custom sidebar templates, maps document names to template names.
142#html_sidebars = {}
143
144# Additional templates that should be rendered to pages, maps page names to
145# template names.
146#html_additional_pages = {}
147
148# If false, no module index is generated.
149#html_domain_indices = True
150
151# If false, no index is generated.
152#html_use_index = True
153
154# If true, the index is split into individual pages for each letter.
155#html_split_index = False
156
157# If true, links to the reST sources are added to the pages.
158#html_show_sourcelink = True
159
160# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
161html_show_sphinx = False
162
163# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
164#html_show_copyright = True
165
166# If true, an OpenSearch description file will be output, and all pages will
167# contain a <link> tag referring to it.  The value of this option must be the
168# base URL from which the finished HTML is served.
169#html_use_opensearch = ''
170
171# This is the file name suffix for HTML files (e.g. ".xhtml").
172#html_file_suffix = None
173
174# Output file base name for HTML help builder.
175htmlhelp_basename = 'aubiodoc'
176
177
178# -- Options for LaTeX output --------------------------------------------------
179
180latex_elements = {
181# The paper size ('letterpaper' or 'a4paper').
182#'papersize': 'letterpaper',
183
184# The font size ('10pt', '11pt' or '12pt').
185#'pointsize': '10pt',
186
187# Additional stuff for the LaTeX preamble.
188#'preamble': '',
189}
190
191# Grouping the document tree into LaTeX files. List of tuples
192# (source start file, target name, title, author, documentclass [howto/manual]).
193latex_documents = [
194  ('index', 'aubio.tex', u'aubio Documentation',
195   u'Paul Brossier', 'manual'),
196]
197
198# The name of an image file (relative to this directory) to place at the top of
199# the title page.
200#latex_logo = None
201
202# For "manual" documents, if this is true, then toplevel headings are parts,
203# not chapters.
204#latex_use_parts = False
205
206# If true, show page references after internal links.
207#latex_show_pagerefs = False
208
209# If true, show URL addresses after external links.
210#latex_show_urls = False
211
212# Documents to append as an appendix to all manuals.
213#latex_appendices = []
214
215# If false, no module index is generated.
216#latex_domain_indices = True
217
218
219# -- Options for manual page output --------------------------------------------
220
221# One entry per manual page. List of tuples
222# (source start file, name, description, authors, manual section).
223man_pages = [
224    ('index', 'aubio', u'aubio Documentation',
225     [u'Paul Brossier'], 1)
226]
227
228# If true, show URL addresses after external links.
229#man_show_urls = False
230
231
232# -- Options for Texinfo output ------------------------------------------------
233
234# Grouping the document tree into Texinfo files. List of tuples
235# (source start file, target name, title, author,
236#  dir menu entry, description, category)
237texinfo_documents = [
238  ('index', 'aubio', u'aubio Documentation',
239   u'Paul Brossier', 'aubio', 'One line description of project.',
240   'Miscellaneous'),
241]
242
243# Documents to append as an appendix to all manuals.
244#texinfo_appendices = []
245
246# If false, no module index is generated.
247#texinfo_domain_indices = True
248
249# How to display URL addresses: 'footnote', 'no', or 'inline'.
250#texinfo_show_urls = 'footnote'
251
252def setup(app):
253    if release.endswith('~alpha'): app.tags.add('devel')
Note: See TracBrowser for help on using the repository browser.