#!/usr/bin/env python3

# -*- coding: utf-8 -*-

#

# PoreSpy documentation build configuration file, created by

# sphinx-quickstart on Fri Jul 28 00:04:40 2017.

#

# 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.

# 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.

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.

#

# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.

              'sphinx.ext.napoleon',

              'sphinx.ext.autosummary',

              'sphinx.ext.ifconfig',

              'sphinx.ext.viewcode',

              'sphinx.ext.mathjax',

              ]

# Add any paths that contain templates here, relative to this directory.

# The suffix(es) of source filenames.

# You can specify multiple suffix as a list of string:

# The master toctree document.

# General information about the project.

# 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.

# version = '0.2'

# The full version, including alpha/beta/rc tags.

# release = '0.2'

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

#

# This is also used if you do content translation via gettext catalogs.

# Usually you set "language" from the command line for these cases.

# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

# This patterns also effect to html_static_path and html_extra_path

# The name of the Pygments (syntax highlighting) style to use.

# If true, `todo` and `todoList` produce output, else they produce nothing.

# A list of ignored prefixes for module index sorting.

# If false, no module index is generated.

# If false, no index is generated.

# If true, the index is split into individual pages for each letter.

# If true, links to the reST sources are added to the pages.

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for

# a list of builtin themes.

#

# 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 = {}

# 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".

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.

# -- Options for LaTeX output ---------------------------------------------

    # The paper size ('letterpaper' or 'a4paper').

    #

    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').

    #

    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.

    #

    # 'preamble': '',

    # Latex figure (float) alignment

    #

    # 'figure_align': 'htbp',

}

# Grouping the document tree into LaTeX files. List of tuples

# (source start file, target name, title,

#  author, documentclass [howto, manual, or own class]).

    (master_doc, 'PoreSpy.tex', 'PoreSpy Documentation',

     'PMEAL Team', 'manual'),

]

# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples

# (source start file, name, description, authors, manual section).

    (master_doc, 'porespy', 'PoreSpy Documentation',

     [author], 1)

]

# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples

# (source start file, target name, title, author,

#  dir menu entry, description, category)

    (master_doc, 'PoreSpy', 'PoreSpy Documentation',

     author, 'PoreSpy', 'One line description of project.',

     'Miscellaneous'),

]