zolfa
/
zolfa-nd2reader


								#!/usr/bin/env python3

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

								import sphinx_bootstrap_theme

								from recommonmark.parser import CommonMarkParser

								from zolfa.nd2reader.version import __version__ as VERSION


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

								extensions = ['sphinx.ext.autodoc',

								              'sphinx.ext.todo',

								              'sphinx.ext.viewcode',

								              'sphinx.ext.napoleon']


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

								templates_path = ['_templates']


								# The suffix(es) of source filenames.

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

								#

								# source_suffix = ['.rst', '.md']


								source_parsers = {

								    '.md': CommonMarkParser,

								}


								source_suffix = ['.rst', '.md']


								# The master toctree document.

								master_doc = 'index'


								# General information about the project.

								project = 'zolfa-nd2reader'

								copyright = '2017 - 2019, Ruben Verweij'

								author = 'Ruben Verweij, Lorenzo Zolfanelli'


								# 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 = VERSION

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

								release = VERSION


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

								language = 'en'


								# 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

								exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


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

								pygments_style = 'sphinx'


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

								todo_include_todos = True


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


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

								# a list of builtin themes.

								#

								html_theme = 'bootstrap'

								html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()


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

								'navbar_links': [

								        ("Lighthacking", "http://lighthacking.nl", True),

								    ],

								}


								# 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 = []


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


								# Output file base name for HTML help builder.

								htmlhelp_basename = 'nd2readerdoc'


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


								latex_elements = {

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

								latex_documents = [

								    (master_doc, 'nd2reader.tex', 'nd2reader Documentation',

								     'Ruben Verweij', 'manual'),

								]


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


								# One entry per manual page. List of tuples

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

								man_pages = [

								    (master_doc, 'nd2reader', 'nd2reader 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)

								texinfo_documents = [

								    (master_doc, 'nd2reader', 'nd2reader Documentation',

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

								     'Miscellaneous'),

								]


								# -- Options for Epub output ----------------------------------------------


								# Bibliographic Dublin Core info.

								epub_title = project

								epub_author = author

								epub_publisher = author

								epub_copyright = copyright


								# The unique identifier of the text. This can be a ISBN number

								# or the project homepage.

								#

								# epub_identifier = ''


								# A unique identification for the text.

								#

								# epub_uid = ''


								# A list of files that should not be packed into the epub file.

								epub_exclude_files = ['search.html']