Kotti/Kotti

# -*- coding: utf-8 -*-
#
# Kotti documentation build configuration file, created by
# sphinx-quickstart on Fri Mar 18 23:14:47 2011.
#
# 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.

import os
import pkg_resources
from datetime import date

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

extensions = [
    'repoze.sphinx.autointerface',
    'sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinx.ext.graphviz',
    'sphinx.ext.inheritance_diagram',
    'sphinx.ext.intersphinx',
    'sphinx.ext.viewcode',
    ]

copyright = u'2012-{0}, Kotti developers'.format(date.today().year)
exclude_patterns = ['_build', '_themes']
master_doc = 'index'
project = u'Kotti'
pygments_style = 'sphinx'
source_suffix = '.rst'
templates_path = ['_templates']
today_fmt = '%Y-%m-%d'
# The full version, including alpha/beta/rc tags.
version = pkg_resources.get_distribution("Kotti").version
release = version

# add_function_parentheses = True
# add_module_names = True
# default_role = None
# language = None
# modindex_common_prefix = []
# show_authors = False
# source_encoding = 'utf-8-sig'

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

# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get('READTHEDOCS') == 'True'

if not on_rtd:  # only import and set the theme if we're building docs locally
    import sphinx_rtd_theme
    html_theme = 'sphinx_rtd_theme'
    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
# A shorter title for the navigation bar.  Default is the same as html_title.
html_last_updated_fmt = '%Y-%m-%d'
html_static_path = ['_static']
htmlhelp_basename = 'Kottidoc'
# html_additional_pages = {}
# html_domain_indices = True
# html_favicon = None
# html_file_suffix = None
# html_logo = None
# html_short_title = None
# html_show_copyright = True
# html_show_sourcelink = True
# html_show_sphinx = True
# html_sidebars = {}
# html_split_index = False
# html_title = None
# html_use_index = True
# html_use_opensearch = ''
# html_use_smartypants = True


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

# latex_appendices = []
# latex_documents = [
#     ('index', 'Kotti.tex', u'Kotti Documentation', u'Daniel Nouri', 'manual'),
# ]
# latex_domain_indices = True
# latex_font_size = '10pt'
# latex_logo = None
# latex_paper_size = 'a4'
# latex_preamble = ''
# latex_show_pagerefs = False
# latex_show_urls = False
# latex_use_parts = False


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
# man_pages = [
#     ('index', 'kotti', u'Kotti Documentation', [u'Daniel Nouri'], 1)
# ]

# -- Options for inheritance diagrams ------------------------------------------
inheritance_graph_attrs = dict(
    rankdir='TB',
    nodesep=0.1,
    ratio='auto',
    size=11.0
)
inheritance_node_attrs = dict(
    height=0.7,
    margin='"0.06, 0.03"',
    fontname='"Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans"'
)
graphviz_output_format = 'svg'

# -- Options for Intersphinx ---------------------------------------------------
intersphinx_mapping = {
    'bleach': ('https://bleach.readthedocs.io/en/latest/', None),
    'colander': ('https://colander.readthedocs.io/en/latest/', None),
    'deform': ('https://deform.readthedocs.io/en/latest/', None),
    'depot': ('https://depot.readthedocs.io/en/latest/', None),
    'fanstatic': ('http://www.fanstatic.org/en/latest/', None),
    'pyramid': ('https://pyramid.readthedocs.io/en/latest/', None),
    'sqlalchemy': ('https://sqlalchemy.readthedocs.io/en/latest/', None),
}