conf.py

from datetime import date
import sys
import os

sys.path.insert(0, os.path.abspath("../../"))

# from primerize import __version__
__version__ = '1.0.0'

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.napoleon',
    'sphinx.ext.todo',
    'sphinx.ext.mathjax',
    'sphinx.ext.githubpages',
]
templates_path = ['_templates']
html_static_path = ['_static']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
source_suffix = '.rst'
master_doc = 'index'

# General information about the project.
project = u'PROJ_NAME'
copyright = u'2016-%s YOUR AWESOME NAME. All Rights Reserved' % date.today().year
author = u'Siqi Tian'
language = 'en'

version = __version__
release = version


pygments_style = 'sphinx'
add_function_parentheses = True
add_module_names = True
show_authors = False
todo_include_todos = True
man_show_urls = True
modindex_common_prefix = []

html_domain_indices = True
html_use_smartypants = False
html_use_index = True
html_use_modindex = False
html_split_index = False
html_show_sourcelink = False
html_show_sphinx = True
html_show_copyright = True
html_copy_source = True
html_compact_lists = True
html_last_updated_fmt = '%b %d, %Y'
html_search_language = 'en'

html_title = project + ' ' + version + ' : SHORT_DESCRIPTION'
html_short_title = project + ' Documentation'
html_logo = None
html_extra_path = []
html_favicon = html_static_path[0] + '/ribokit_icon.png'

html_sidebars = {}
html_context = {}
html_style = []
html_theme = 'ribokit-Sphinx-theme'
html_theme_path = ['_theme']
html_theme_options = {
    'description': 'SHORT_DESCRIPTION',
    'author': author.split(',')[0].strip(),
    'github_repo': 'org/repo',
    'ga_tracker': 'UA-12345678-9'
}
html_additional_pages = {'404': '404.html'}

# Output file base name for HTML help builder.
htmlhelp_basename = 'PROJ_NAME_doc'


napoleon_google_docstring = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_rtype = False
autodoc_member_order = 'groupwise'
autodoc_default_flags = ['members', 'show-inheritance']
autosummary_generate = True