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