source: doc/conf.py

Last change on this file was 152bf4f, checked in by Paul Brossier <piem@piem.org>, 13 months ago

[doc] start adding autodoc to sphinx documents

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