peterf@2: # -*- coding: utf-8 -*-
peterf@2: #
peterf@2: # librosa documentation build configuration file, created by
peterf@2: # sphinx-quickstart on Tue Jun 25 13:12:33 2013.
peterf@2: #
peterf@2: # This file is execfile()d with the current directory set to its containing dir.
peterf@2: #
peterf@2: # Note that not all possible configuration values are present in this
peterf@2: # autogenerated file.
peterf@2: #
peterf@2: # All configuration values have a default; values that are commented out
peterf@2: # serve to show the default.
peterf@2: 
peterf@2: import sys, os
peterf@2: 
peterf@2: # If extensions (or modules to document with autodoc) are in another directory,
peterf@2: # add these directories to sys.path here. If the directory is relative to the
peterf@2: # documentation root, use os.path.abspath to make it absolute, like shown here.
peterf@2: sys.path.insert(0, os.path.abspath('../librosa'))
peterf@2: 
peterf@2: # -- General configuration -----------------------------------------------------
peterf@2: 
peterf@2: # If your documentation needs a minimal Sphinx version, state it here.
peterf@2: #needs_sphinx = '1.0'
peterf@2: 
peterf@2: # Add any Sphinx extension module names here, as strings. They can be extensions
peterf@2: # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
peterf@2: extensions = ['sphinx.ext.autodoc']
peterf@2: 
peterf@2: # Add any paths that contain templates here, relative to this directory.
peterf@2: templates_path = ['_templates']
peterf@2: 
peterf@2: # The suffix of source filenames.
peterf@2: source_suffix = '.rst'
peterf@2: 
peterf@2: # The encoding of source files.
peterf@2: #source_encoding = 'utf-8-sig'
peterf@2: 
peterf@2: # The master toctree document.
peterf@2: master_doc = 'index'
peterf@2: 
peterf@2: # General information about the project.
peterf@2: project = u'librosa'
peterf@2: copyright = u'2014, Dawen Liang, Brian McFee, Matt McVicar, Colin Raffel'
peterf@2: 
peterf@2: # The version info for the project you're documenting, acts as replacement for
peterf@2: # |version| and |release|, also used in various other places throughout the
peterf@2: # built documents.
peterf@2: #
peterf@2: # The short X.Y version.
peterf@2: version = '0.3'
peterf@2: # The full version, including alpha/beta/rc tags.
peterf@2: release = '0.3.1'
peterf@2: 
peterf@2: # The language for content autogenerated by Sphinx. Refer to documentation
peterf@2: # for a list of supported languages.
peterf@2: #language = None
peterf@2: 
peterf@2: # There are two options for replacing |today|: either, you set today to some
peterf@2: # non-false value, then it is used:
peterf@2: #today = ''
peterf@2: # Else, today_fmt is used as the format for a strftime call.
peterf@2: #today_fmt = '%B %d, %Y'
peterf@2: 
peterf@2: # List of patterns, relative to source directory, that match files and
peterf@2: # directories to ignore when looking for source files.
peterf@2: exclude_patterns = ['_build']
peterf@2: 
peterf@2: # The reST default role (used for this markup: `text`) to use for all documents.
peterf@2: #default_role = None
peterf@2: 
peterf@2: # If true, '()' will be appended to :func: etc. cross-reference text.
peterf@2: #add_function_parentheses = True
peterf@2: 
peterf@2: # If true, the current module name will be prepended to all description
peterf@2: # unit titles (such as .. function::).
peterf@2: add_module_names = True
peterf@2: 
peterf@2: # If true, sectionauthor and moduleauthor directives will be shown in the
peterf@2: # output. They are ignored by default.
peterf@2: show_authors = False
peterf@2: 
peterf@2: # The name of the Pygments (syntax highlighting) style to use.
peterf@2: pygments_style = 'sphinx'
peterf@2: 
peterf@2: # A list of ignored prefixes for module index sorting.
peterf@2: #modindex_common_prefix = []
peterf@2: 
peterf@2: 
peterf@2: # -- Options for HTML output ---------------------------------------------------
peterf@2: 
peterf@2: # The theme to use for HTML and HTML Help pages.  See the documentation for
peterf@2: # a list of builtin themes.
peterf@2: import sphinx_bootstrap_theme
peterf@2: html_theme = 'bootstrap'
peterf@2: 
peterf@2: # Theme options are theme-specific and customize the look and feel of a theme
peterf@2: # further.  For a list of options available for each theme, see the
peterf@2: # documentation.
peterf@2: html_theme_options = {
peterf@2:     'bootswatch_theme':     'yeti', 
peterf@2:     'bootstrap_version':    '3',
peterf@2:     'navbar_title':         'LibROSA',
peterf@2:     'source_link_position': None,
peterf@2: 
peterf@2: }
peterf@2: 
peterf@2: # Add any paths that contain custom themes here, relative to this directory.
peterf@2: html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
peterf@2: 
peterf@2: # The name for this set of Sphinx documents.  If None, it defaults to
peterf@2: # "<project> v<release> documentation".
peterf@2: #html_title = None
peterf@2: 
peterf@2: # A shorter title for the navigation bar.  Default is the same as html_title.
peterf@2: #html_short_title = None
peterf@2: 
peterf@2: # The name of an image file (relative to this directory) to place at the top
peterf@2: # of the sidebar.
peterf@2: #html_logo = None
peterf@2: 
peterf@2: # The name of an image file (within the static path) to use as favicon of the
peterf@2: # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
peterf@2: # pixels large.
peterf@2: #html_favicon = None
peterf@2: 
peterf@2: # Add any paths that contain custom static files (such as style sheets) here,
peterf@2: # relative to this directory. They are copied after the builtin static files,
peterf@2: # so a file named "default.css" will overwrite the builtin "default.css".
peterf@2: html_static_path = ['_static']
peterf@2: 
peterf@2: # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
peterf@2: # using the given strftime format.
peterf@2: #html_last_updated_fmt = '%b %d, %Y'
peterf@2: 
peterf@2: # If true, SmartyPants will be used to convert quotes and dashes to
peterf@2: # typographically correct entities.
peterf@2: # html_use_smartypants = True
peterf@2: 
peterf@2: # Custom sidebar templates, maps document names to template names.
peterf@2: #html_sidebars = {}
peterf@2: 
peterf@2: # Additional templates that should be rendered to pages, maps page names to
peterf@2: # template names.
peterf@2: #html_additional_pages = {}
peterf@2: 
peterf@2: # If false, no module index is generated.
peterf@2: #html_domain_indices = True
peterf@2: 
peterf@2: # If false, no index is generated.
peterf@2: html_use_index = True
peterf@2: 
peterf@2: # If true, the index is split into individual pages for each letter.
peterf@2: # html_split_index = False
peterf@2: 
peterf@2: # If true, links to the reST sources are added to the pages.
peterf@2: #html_show_sourcelink = True
peterf@2: 
peterf@2: # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
peterf@2: #html_show_sphinx = True
peterf@2: 
peterf@2: # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
peterf@2: #html_show_copyright = True
peterf@2: 
peterf@2: # If true, an OpenSearch description file will be output, and all pages will
peterf@2: # contain a <link> tag referring to it.  The value of this option must be the
peterf@2: # base URL from which the finished HTML is served.
peterf@2: #html_use_opensearch = ''
peterf@2: 
peterf@2: # This is the file name suffix for HTML files (e.g. ".xhtml").
peterf@2: #html_file_suffix = None
peterf@2: 
peterf@2: # Output file base name for HTML help builder.
peterf@2: htmlhelp_basename = 'librosadoc'
peterf@2: 
peterf@2: 
peterf@2: # -- Options for LaTeX output --------------------------------------------------
peterf@2: 
peterf@2: latex_elements = {
peterf@2: # The paper size ('letterpaper' or 'a4paper').
peterf@2: #'papersize': 'letterpaper',
peterf@2: 
peterf@2: # The font size ('10pt', '11pt' or '12pt').
peterf@2: #'pointsize': '10pt',
peterf@2: 
peterf@2: # Additional stuff for the LaTeX preamble.
peterf@2: #'preamble': '',
peterf@2: }
peterf@2: 
peterf@2: # Grouping the document tree into LaTeX files. List of tuples
peterf@2: # (source start file, target name, title, author, documentclass [howto/manual]).
peterf@2: latex_documents = [
peterf@2:   ('index', 'librosa.tex', u'librosa Documentation',
peterf@2:    u'Dawen Liang, Brian McFee, Matt McVicar, Colin Raffel', 'manual'),
peterf@2: ]
peterf@2: 
peterf@2: # The name of an image file (relative to this directory) to place at the top of
peterf@2: # the title page.
peterf@2: #latex_logo = None
peterf@2: 
peterf@2: # For "manual" documents, if this is true, then toplevel headings are parts,
peterf@2: # not chapters.
peterf@2: #latex_use_parts = False
peterf@2: 
peterf@2: # If true, show page references after internal links.
peterf@2: #latex_show_pagerefs = False
peterf@2: 
peterf@2: # If true, show URL addresses after external links.
peterf@2: #latex_show_urls = False
peterf@2: 
peterf@2: # Documents to append as an appendix to all manuals.
peterf@2: #latex_appendices = []
peterf@2: 
peterf@2: # If false, no module index is generated.
peterf@2: #latex_domain_indices = True
peterf@2: 
peterf@2: 
peterf@2: # -- Options for manual page output --------------------------------------------
peterf@2: 
peterf@2: # One entry per manual page. List of tuples
peterf@2: # (source start file, name, description, authors, manual section).
peterf@2: man_pages = [
peterf@2:     ('index', 'librosa', u'librosa Documentation',
peterf@2:      [u'Dawen Liang, Brian McFee, Matt McVicar, Colin Raffel'], 1)
peterf@2: ]
peterf@2: 
peterf@2: # If true, show URL addresses after external links.
peterf@2: #man_show_urls = False
peterf@2: 
peterf@2: 
peterf@2: # -- Options for Texinfo output ------------------------------------------------
peterf@2: 
peterf@2: # Grouping the document tree into Texinfo files. List of tuples
peterf@2: # (source start file, target name, title, author,
peterf@2: #  dir menu entry, description, category)
peterf@2: texinfo_documents = [
peterf@2:   ('index', 'librosa', u'librosa Documentation',
peterf@2:    u'Dawen Liang, Brian McFee, Matt McVicar, Colin Raffel', 'librosa', 'One line description of project.',
peterf@2:    'Miscellaneous'),
peterf@2: ]
peterf@2: 
peterf@2: # Documents to append as an appendix to all manuals.
peterf@2: #texinfo_appendices = []
peterf@2: 
peterf@2: # If false, no module index is generated.
peterf@2: #texinfo_domain_indices = True
peterf@2: 
peterf@2: # How to display URL addresses: 'footnote', 'no', or 'inline'.
peterf@2: #texinfo_show_urls = 'footnote'