# -*- coding: utf-8 -*-1#2# scikit-image tutorials documentation build configuration file, created by3# sphinx-quickstart on Fri Jun 6 00:53:03 2014.4#5# This file is execfile()d with the current directory set to its containing dir.6#7# Note that not all possible configuration values are present in this8# autogenerated file.9#10# All configuration values have a default; values that are commented out11# serve to show the default.1213import sys, os1415# If extensions (or modules to document with autodoc) are in another directory,16# add these directories to sys.path here. If the directory is relative to the17# documentation root, use os.path.abspath to make it absolute, like shown here.18#sys.path.insert(0, os.path.abspath('.'))1920# -- General configuration -----------------------------------------------------2122# If your documentation needs a minimal Sphinx version, state it here.23#needs_sphinx = '1.0'2425# Add any Sphinx extension module names here, as strings. They can be extensions26# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.27extensions = ['sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode']2829# Add any paths that contain templates here, relative to this directory.30templates_path = ['_templates']3132# The suffix of source filenames.33source_suffix = '.rst'3435# The encoding of source files.36#source_encoding = 'utf-8-sig'3738# The master toctree document.39master_doc = 'index'4041# General information about the project.42project = u'Learn scikit-image'43copyright = u'2016, scikit-image devs'4445# The version info for the project you're documenting, acts as replacement for46# |version| and |release|, also used in various other places throughout the47# built documents.48#49# The short X.Y version.50version = '0.1'51# The full version, including alpha/beta/rc tags.52release = '0.1'5354# The language for content autogenerated by Sphinx. Refer to documentation55# for a list of supported languages.56#language = None5758# There are two options for replacing |today|: either, you set today to some59# non-false value, then it is used:60#today = ''61# Else, today_fmt is used as the format for a strftime call.62#today_fmt = '%B %d, %Y'6364# List of patterns, relative to source directory, that match files and65# directories to ignore when looking for source files.66exclude_patterns = []6768# The reST default role (used for this markup: `text`) to use for all documents.69#default_role = None7071# If true, '()' will be appended to :func: etc. cross-reference text.72#add_function_parentheses = True7374# If true, the current module name will be prepended to all description75# unit titles (such as .. function::).76#add_module_names = True7778# If true, sectionauthor and moduleauthor directives will be shown in the79# output. They are ignored by default.80#show_authors = False8182# The name of the Pygments (syntax highlighting) style to use.83pygments_style = 'sphinx'8485# A list of ignored prefixes for module index sorting.86#modindex_common_prefix = []878889# -- Options for HTML output ---------------------------------------------------9091# The theme to use for HTML and HTML Help pages. See the documentation for92# a list of builtin themes.<F4>93import sphinx_rtd_theme94html_theme = 'sphinx_rtd_theme'9596# Theme options are theme-specific and customize the look and feel of a theme97# further. For a list of options available for each theme, see the98# documentation.99#html_theme_options = {}100101# Add any paths that contain custom themes here, relative to this directory.102html_theme_path = ['themes', sphinx_rtd_theme.get_html_theme_path()]103104# The name for this set of Sphinx documents. If None, it defaults to105# "<project> v<release> documentation".106#html_title = None107108# A shorter title for the navigation bar. Default is the same as html_title.109#html_short_title = None110111# The name of an image file (relative to this directory) to place at the top112# of the sidebar.113#html_logo = None114115# The name of an image file (within the static path) to use as favicon of the116# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32117# pixels large.118#html_favicon = None119120# Add any paths that contain custom static files (such as style sheets) here,121# relative to this directory. They are copied after the builtin static files,122# so a file named "default.css" will overwrite the builtin "default.css".123html_static_path = ['_static']124125# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,126# using the given strftime format.127#html_last_updated_fmt = '%b %d, %Y'128129# If true, SmartyPants will be used to convert quotes and dashes to130# typographically correct entities.131#html_use_smartypants = True132133# Custom sidebar templates, maps document names to template names.134#html_sidebars = {}135136# Additional templates that should be rendered to pages, maps page names to137# template names.138#html_additional_pages = {}139140# If false, no module index is generated.141#html_domain_indices = True142143# If false, no index is generated.144#html_use_index = True145146# If true, the index is split into individual pages for each letter.147#html_split_index = False148149# If true, links to the reST sources are added to the pages.150#html_show_sourcelink = True151152# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.153#html_show_sphinx = True154155# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.156#html_show_copyright = True157158# If true, an OpenSearch description file will be output, and all pages will159# contain a <link> tag referring to it. The value of this option must be the160# base URL from which the finished HTML is served.161#html_use_opensearch = ''162163# This is the file name suffix for HTML files (e.g. ".xhtml").164#html_file_suffix = None165166# Output file base name for HTML help builder.167htmlhelp_basename = 'scikit-imagetutorialsdoc'168169170# -- Options for LaTeX output --------------------------------------------------171172latex_elements = {173# The paper size ('letterpaper' or 'a4paper').174#'papersize': 'letterpaper',175176# The font size ('10pt', '11pt' or '12pt').177#'pointsize': '10pt',178179# Additional stuff for the LaTeX preamble.180#'preamble': '',181}182183# Grouping the document tree into LaTeX files. List of tuples184# (source start file, target name, title, author, documentclass [howto/manual]).185latex_documents = [186('index', 'scikit-imagetutorials.tex', u'scikit-image tutorials Documentation',187u'scikit-image devs', 'manual'),188]189190# The name of an image file (relative to this directory) to place at the top of191# the title page.192#latex_logo = None193194# For "manual" documents, if this is true, then toplevel headings are parts,195# not chapters.196#latex_use_parts = False197198# If true, show page references after internal links.199#latex_show_pagerefs = False200201# If true, show URL addresses after external links.202#latex_show_urls = False203204# Documents to append as an appendix to all manuals.205#latex_appendices = []206207# If false, no module index is generated.208#latex_domain_indices = True209210211# -- Options for manual page output --------------------------------------------212213# One entry per manual page. List of tuples214# (source start file, name, description, authors, manual section).215man_pages = [216('index', 'scikit-imagetutorials', u'scikit-image tutorials Documentation',217[u'scikit-image devs'], 1)218]219220# If true, show URL addresses after external links.221#man_show_urls = False222223224# -- Options for Texinfo output ------------------------------------------------225226# Grouping the document tree into Texinfo files. List of tuples227# (source start file, target name, title, author,228# dir menu entry, description, category)229texinfo_documents = [230('index', 'scikit-imagetutorials', u'scikit-image tutorials Documentation',231u'scikit-image devs', 'scikit-imagetutorials', 'One line description of project.',232'Miscellaneous'),233]234235# Documents to append as an appendix to all manuals.236#texinfo_appendices = []237238# If false, no module index is generated.239#texinfo_domain_indices = True240241# How to display URL addresses: 'footnote', 'no', or 'inline'.242#texinfo_show_urls = 'footnote'243244from recommonmark.parser import CommonMarkParser245246source_parsers = {247'.md': CommonMarkParser,248}249source_suffix = ['.rst', '.md', '.txt']250251def setup(app):252app.add_stylesheet("sphinx_rtd_customize.css")253254255