# -*- coding: utf-8 -*-1#2# Configuration file for the Sphinx documentation builder.3#4# This file does only contain a selection of the most common options. For a5# full list see the documentation:6# http://www.sphinx-doc.org/en/master/config78# -- Path setup --------------------------------------------------------------910# If extensions (or modules to document with autodoc) are in another directory,11# add these directories to sys.path here. If the directory is relative to the12# documentation root, use os.path.abspath to make it absolute, like shown here.13#14# import os15# import sys16# sys.path.insert(0, os.path.abspath('.'))171819# -- Project information -----------------------------------------------------2021project = 'Dask Tutorial'22copyright = '2018, Dask Developers'23author = 'Dask Developers'2425# The short X.Y version26version = ''27# The full version, including alpha/beta/rc tags28release = ''293031# -- General configuration ---------------------------------------------------3233# If your documentation needs a minimal Sphinx version, state it here.34#35# needs_sphinx = '1.0'3637# Add any Sphinx extension module names here, as strings. They can be38# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom39# ones.40extensions = [41"sphinx.ext.mathjax",42'nbsphinx',43]4445nbsphinx_timeout = 60046# nbsphinx_execute = "always"47nbsphinx_execute = 'never'484950nbsphinx_prolog = """51{% set docname = env.doc2path(env.docname, base=None) %}5253You can run this notebook in a `live session <https://mybinder.org/v2/gh/dask/dask-tutorial/master?urlpath=lab/tree/{{54docname }}>`_ |Binder| or view it `on Github <https://github.com/dask/dask-tutorial/blob/master/{{ docname }}>`_.5556.. |Binder| image:: https://mybinder.org/badge.svg57:target: https://mybinder.org/v2/gh/dask/dask-tutorial/master?urlpath=lab/tree/{{ docname }}58"""596061# Add any paths that contain templates here, relative to this directory.62templates_path = ['_templates']6364# The suffix(es) of source filenames.65# You can specify multiple suffix as a list of string:66#67# source_suffix = ['.rst', '.md']68source_suffix = '.rst'6970# The master toctree document.71master_doc = 'index'7273# The language for content autogenerated by Sphinx. Refer to documentation74# for a list of supported languages.75#76# This is also used if you do content translation via gettext catalogs.77# Usually you set "language" from the command line for these cases.78language = None7980# List of patterns, relative to source directory, that match files and81# directories to ignore when looking for source files.82# This pattern also affects html_static_path and html_extra_path .83exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints']8485# The name of the Pygments (syntax highlighting) style to use.86pygments_style = 'sphinx'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.93#94html_theme = 'dask_sphinx_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#100# html_theme_options = {}101102# Add any paths that contain custom static files (such as style sheets) here,103# relative to this directory. They are copied after the builtin static files,104# so a file named "default.css" will overwrite the builtin "default.css".105html_static_path = ['_static']106107# Custom sidebar templates, must be a dictionary that maps document names108# to template names.109#110# The default sidebars (for documents that don't match any pattern) are111# defined by theme itself. Builtin themes are using these templates by112# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',113# 'searchbox.html']``.114#115# html_sidebars = {}116117118# -- Options for HTMLHelp output ---------------------------------------------119120# Output file base name for HTML help builder.121htmlhelp_basename = 'DaskTutorialdoc'122123124# -- Options for LaTeX output ------------------------------------------------125126latex_elements = {127# The paper size ('letterpaper' or 'a4paper').128#129# 'papersize': 'letterpaper',130131# The font size ('10pt', '11pt' or '12pt').132#133# 'pointsize': '10pt',134135# Additional stuff for the LaTeX preamble.136#137# 'preamble': '',138139# Latex figure (float) alignment140#141# 'figure_align': 'htbp',142}143144# Grouping the document tree into LaTeX files. List of tuples145# (source start file, target name, title,146# author, documentclass [howto, manual, or own class]).147latex_documents = [148(master_doc, 'DaskTutorial.tex', 'Dask Tutorial Documentation',149'Dask Developers', 'manual'),150]151152153# -- Options for manual page output ------------------------------------------154155# One entry per manual page. List of tuples156# (source start file, name, description, authors, manual section).157man_pages = [158(master_doc, 'dasktutorial', 'Dask Tutorial Documentation',159[author], 1)160]161162163# -- Options for Texinfo output ----------------------------------------------164165# Grouping the document tree into Texinfo files. List of tuples166# (source start file, target name, title, author,167# dir menu entry, description, category)168texinfo_documents = [169(master_doc, 'DaskTutorial', 'Dask Tutorial Documentation',170author, 'DaskTutorial', 'One line description of project.',171'Miscellaneous'),172]173174175