1 # -*- coding: utf-8 -*-
3 # aubio documentation build configuration file, created by
4 # sphinx-quickstart on Sun Jan 26 20:43:11 2014.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
16 # get version using this_version.py
17 sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
18 from this_version import get_aubio_version
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/...'))
25 # -- General configuration -----------------------------------------------------
27 # If your documentation needs a minimal Sphinx version, state it here.
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.
32 extensions = ['sphinx.ext.viewcode', 'sphinx.ext.autodoc']
34 # Add any paths that contain templates here, relative to this directory.
35 templates_path = ['_templates']
37 # The suffix of source filenames.
38 source_suffix = '.rst'
40 # The encoding of source files.
41 #source_encoding = 'utf-8-sig'
43 # The master toctree document.
46 # General information about the project.
48 copyright = u'2016, Paul Brossier'
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
54 # The short X.Y version.
56 version = get_aubio_version()[:3]
57 # The full version, including alpha/beta/rc tags.
58 release = get_aubio_version()
60 # The language for content autogenerated by Sphinx. Refer to documentation
61 # for a list of supported languages.
64 # There are two options for replacing |today|: either, you set today to some
65 # non-false value, then it is used:
67 # Else, today_fmt is used as the format for a strftime call.
68 #today_fmt = '%B %d, %Y'
70 # List of patterns, relative to source directory, that match files and
71 # directories to ignore when looking for source files.
72 exclude_patterns = ['_build',
76 'debian_packages.rst',
79 'xcode_frameworks.rst',
84 # The reST default role (used for this markup: `text`) to use for all documents.
87 # If true, '()' will be appended to :func: etc. cross-reference text.
88 #add_function_parentheses = True
90 # If true, the current module name will be prepended to all description
91 # unit titles (such as .. function::).
92 #add_module_names = True
94 # If true, sectionauthor and moduleauthor directives will be shown in the
95 # output. They are ignored by default.
98 # The name of the Pygments (syntax highlighting) style to use.
99 pygments_style = 'colorful'
101 # A list of ignored prefixes for module index sorting.
102 modindex_common_prefix = ['aubio.']
105 # -- Options for HTML output ---------------------------------------------------
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'
112 html_theme = 'pyramid'
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
117 #html_theme_options = {}
119 # Add any paths that contain custom themes here, relative to this directory.
120 #html_theme_path = []
122 # The name for this set of Sphinx documents. If None, it defaults to
123 # "<project> v<release> documentation".
126 # A shorter title for the navigation bar. Default is the same as html_title.
127 #html_short_title = None
129 # The name of an image file (relative to this directory) to place at the top
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
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".
141 html_static_path = [] #['_static']
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'
147 # If true, SmartyPants will be used to convert quotes and dashes to
148 # typographically correct entities.
149 #html_use_smartypants = True
151 # Custom sidebar templates, maps document names to template names.
154 # Additional templates that should be rendered to pages, maps page names to
156 #html_additional_pages = {}
158 # If false, no module index is generated.
159 #html_domain_indices = True
161 # If false, no index is generated.
162 #html_use_index = True
164 # If true, the index is split into individual pages for each letter.
165 #html_split_index = False
167 # If true, links to the reST sources are added to the pages.
168 #html_show_sourcelink = True
170 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
171 html_show_sphinx = False
173 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
174 #html_show_copyright = True
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 = ''
181 # This is the file name suffix for HTML files (e.g. ".xhtml").
182 #html_file_suffix = None
184 # Output file base name for HTML help builder.
185 htmlhelp_basename = 'aubiodoc'
188 # -- Options for LaTeX output --------------------------------------------------
191 # The paper size ('letterpaper' or 'a4paper').
192 #'papersize': 'letterpaper',
194 # The font size ('10pt', '11pt' or '12pt').
195 #'pointsize': '10pt',
197 # Additional stuff for the LaTeX preamble.
201 # Grouping the document tree into LaTeX files. List of tuples
202 # (source start file, target name, title, author, documentclass [howto/manual]).
204 ('index', 'aubio.tex', u'aubio Documentation',
205 u'Paul Brossier', 'manual'),
208 # The name of an image file (relative to this directory) to place at the top of
212 # For "manual" documents, if this is true, then toplevel headings are parts,
214 #latex_use_parts = False
216 # If true, show page references after internal links.
217 #latex_show_pagerefs = False
219 # If true, show URL addresses after external links.
220 #latex_show_urls = False
222 # Documents to append as an appendix to all manuals.
223 #latex_appendices = []
225 # If false, no module index is generated.
226 #latex_domain_indices = True
229 # -- Options for manual page output --------------------------------------------
231 # One entry per manual page. List of tuples
232 # (source start file, name, description, authors, manual section).
234 ('index', 'aubio', u'aubio Documentation',
235 [u'Paul Brossier'], 1)
238 # If true, show URL addresses after external links.
239 #man_show_urls = False
242 # -- Options for Texinfo output ------------------------------------------------
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)
247 texinfo_documents = [
248 ('index', 'aubio', u'aubio Documentation',
249 u'Paul Brossier', 'aubio', 'One line description of project.',
253 # Documents to append as an appendix to all manuals.
254 #texinfo_appendices = []
256 # If false, no module index is generated.
257 #texinfo_domain_indices = True
259 # How to display URL addresses: 'footnote', 'no', or 'inline'.
260 #texinfo_show_urls = 'footnote'
263 if release.endswith('~alpha'): app.tags.add('devel')