content: # -*- coding: utf-8 -*-
  #
  # scikit-learn documentation build configuration file, created by
  # sphinx-quickstart on Fri Jan  8 09:13:42 2010.
  #
  # This file is execfile()d with the current directory set to its containing
  # dir.
  #
  # Note that not all possible configuration values are present in this
  # autogenerated file.
  #
  # All configuration values have a default; values that are commented out
  # serve to show the default.
  
  from __future__ import print_function
  import sys
  import os
  from sklearn.externals.six import u
  
  # If extensions (or modules to document with autodoc) are in another
  # directory, add these directories to sys.path here. If the directory
  # is relative to the documentation root, use os.path.abspath to make it
  # absolute, like shown here.
  sys.path.insert(0, os.path.abspath('sphinxext'))
  
  from github_link import make_linkcode_resolve
  
  # -- General configuration ---------------------------------------------------
  
  # Try to override the matplotlib configuration as early as possible
  try:
      import gen_rst
  except:
      pass
  
  # Add any Sphinx extension module names here, as strings. They can be
  # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  extensions = ['gen_rst',
                'sphinx.ext.autodoc', 'sphinx.ext.autosummary',
                'sphinx.ext.pngmath', 'numpy_ext.numpydoc',
                'sphinx.ext.linkcode',
                ]
  
  autosummary_generate = True
  
  autodoc_default_flags = ['members', 'inherited-members']
  
  # Add any paths that contain templates here, relative to this directory.
  templates_path = ['templates']
  
  # generate autosummary even if no references
  autosummary_generate = True
  
  # The suffix of source filenames.
  source_suffix = '.rst'
  
  # The encoding of source files.
  #source_encoding = 'utf-8'
  
  # Generate the plots for the gallery
  plot_gallery = True
  
  # The master toctree document.
  master_doc = 'index'
  
  # General information about the project.
  project = u('scikit-learn')
  copyright = u('2010 - 2014, scikit-learn developers (BSD License)')
  
  # The version info for the project you're documenting, acts as replacement for
  # |version| and |release|, also used in various other places throughout the
  # built documents.
  #
  # The short X.Y version.
  import sklearn
  version = sklearn.__version__
  # The full version, including alpha/beta/rc tags.
  release = sklearn.__version__
  
  # The language for content autogenerated by Sphinx. Refer to documentation
  # for a list of supported languages.
  #language = None
  
  # There are two options for replacing |today|: either, you set today to some
  # non-false value, then it is used:
  #today = ''
  # Else, today_fmt is used as the format for a strftime call.
  #today_fmt = '%B %d, %Y'
  
  # List of documents that shouldn't be included in the build.
  #unused_docs = []
  
  # List of directories, relative to source directory, that shouldn't be
  # searched for source files.
  exclude_trees = ['_build', 'templates', 'includes']
  
  # The reST default role (used for this markup: `text`) to use for all
  # documents.
  #default_role = None
  
  # If true, '()' will be appended to :func: etc. cross-reference text.
  add_function_parentheses = False
  
  # If true, the current module name will be prepended to all description
  # unit titles (such as .. function::).
  #add_module_names = True
  
  # If true, sectionauthor and moduleauthor directives will be shown in the
  # output. They are ignored by default.
  #show_authors = False
  
  # The name of the Pygments (syntax highlighting) style to use.
  pygments_style = 'sphinx'
  
  # A list of ignored prefixes for module index sorting.
  #modindex_common_prefix = []
  
  
  # -- Options for HTML output -------------------------------------------------
  
  # The theme to use for HTML and HTML Help pages.  Major themes that come with
  # Sphinx are currently 'default' and 'sphinxdoc'.
  html_theme = 'scikit-learn'
  
  # Theme options are theme-specific and customize the look and feel of a theme
  # further.  For a list of options available for each theme, see the
  # documentation.
  html_theme_options = {'oldversion': False, 'collapsiblesidebar': True,
                        'google_analytics': True, 'surveybanner': False,
                        'sprintbanner': True}
  
  # Add any paths that contain custom themes here, relative to this directory.
  html_theme_path = ['themes']
  
  
  # The name for this set of Sphinx documents.  If None, it defaults to
  # "<project> v<release> documentation".
  #html_title = None
  
  # A shorter title for the navigation bar.  Default is the same as html_title.
  html_short_title = 'scikit-learn'
  
  # The name of an image file (relative to this directory) to place at the top
  # of the sidebar.
  html_logo = 'logos/scikit-learn-logo-small.png'
  
  # The name of an image file (within the static path) to use as favicon of the
  # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  # pixels large.
  html_favicon = 'logos/favicon.ico'
  
  # Add any paths that contain custom static files (such as style sheets) here,
  # relative to this directory. They are copied after the builtin static files,
  # so a file named "default.css" will overwrite the builtin "default.css".
  html_static_path = ['images']
  
  # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  # using the given strftime format.
  #html_last_updated_fmt = '%b %d, %Y'
  
  # If true, SmartyPants will be used to convert quotes and dashes to
  # typographically correct entities.
  #html_use_smartypants = True
  
  # Custom sidebar templates, maps document names to template names.
  #html_sidebars = {}
  
  # Additional templates that should be rendered to pages, maps page names to
  # template names.
  #html_additional_pages = {}
  
  # If false, no module index is generated.
  html_domain_indices = False
  
  # If false, no index is generated.
  html_use_index = False
  
  # If true, the index is split into individual pages for each letter.
  #html_split_index = False
  
  # If true, links to the reST sources are added to the pages.
  #html_show_sourcelink = True
  
  # If true, an OpenSearch description file will be output, and all pages will
  # contain a <link> tag referring to it.  The value of this option must be the
  # base URL from which the finished HTML is served.
  #html_use_opensearch = ''
  
  # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  #html_file_suffix = ''
  
  # Output file base name for HTML help builder.
  htmlhelp_basename = 'scikit-learndoc'
  
  
  # -- Options for LaTeX output ------------------------------------------------
  
  # The paper size ('letter' or 'a4').
  #latex_paper_size = 'letter'
  
  # The font size ('10pt', '11pt' or '12pt').
  #latex_font_size = '10pt'
  
  # Grouping the document tree into LaTeX files. List of tuples
  # (source start file, target name, title, author, documentclass
  # [howto/manual]).
  latex_documents = [('index', 'user_guide.tex', u('scikit-learn user guide'),
                      u('scikit-learn developers'), 'manual'), ]
  
  # The name of an image file (relative to this directory) to place at the top of
  # the title page.
  latex_logo = "logos/scikit-learn-logo.png"
  
  # For "manual" documents, if this is true, then toplevel headings are parts,
  # not chapters.
  #latex_use_parts = False
  
  # Additional stuff for the LaTeX preamble.
  latex_preamble = r"""
  \usepackage{amsmath}\usepackage{amsfonts}\usepackage{bm}\usepackage{morefloats}
  \usepackage{enumitem} \setlistdepth{10}
  """
  
  # Documents to append as an appendix to all manuals.
  #latex_appendices = []
  
  # If false, no module index is generated.
  latex_domain_indices = False
  
  trim_doctests_flags = True
  
  
  def generate_example_rst(app, what, name, obj, options, lines):
      # generate empty examples files, so that we don't get
      # inclusion errors if there are no examples for a class / module
      examples_path = os.path.join(app.srcdir, "modules", "generated",
                                   "%s.examples" % name)
      if not os.path.exists(examples_path):
          # touch file
          open(examples_path, 'w').close()
  
  
  def setup(app):
      # to hide/show the prompt in code examples:
      app.add_javascript('js/copybutton.js')
      app.connect('autodoc-process-docstring', generate_example_rst)
  
  
  # The following is used by sphinx.ext.linkcode to provide links to github
  linkcode_resolve = make_linkcode_resolve('sklearn',
                                           u'https://github.com/scikit-learn/'
                                           'scikit-learn/blob/{revision}/'
                                           '{package}/{path}#L{lineno}')
  