jacquev6/LowVoltage

# coding: utf-8

# Copyright 2014-2015 Vincent Jacques <vincent@vincent-jacques.net>

master_doc = "index"
project = "LowVoltage"
author = '<a href="http://vincent-jacques.net/contact">Vincent Jacques</a>'
copyright = "2014-2015 {}".format(author)
extensions = []


nitpicky = True
nitpick_ignore = [
    ("py:class", "datetime.datetime"),
    ("py:class", "exceptions.Exception"),
    ("py:exc", "TypeError"),
]


# https://github.com/bitprophet/alabaster
# html_theme_path
extensions.append("alabaster")
html_theme = "alabaster"
html_sidebars = {
    "**": ["about.html", "navigation.html", "searchbox.html"],
}
html_theme_options = {
    "github_user": "jacquev6",
    "github_repo": project,
    "github_banner": True,
    "travis_button": True,
}


# http://sphinx-doc.org/ext/autodoc.html
extensions.append("sphinx.ext.autodoc")
autoclass_content = "both"
autodoc_member_order = "bysource"
autodoc_default_flags = ["members"]
# autodoc_docstring_signature
# autodoc_mock_imports
add_module_names = False
add_class_names = False


# http://sphinx-doc.org/ext/doctest.html
extensions.append("sphinx.ext.doctest")
# doctest_path
doctest_global_setup = "import LowVoltage.testing.doc_tests; from LowVoltage import *; (connection, table, table2) = LowVoltage.testing.doc_tests.global_setup()"
# doctest_global_cleanup
doctest_test_doctest_blocks=True