streamingtools/conf.py at develop · T-002/streamingtools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Configuration for the Sphinx documentation."""

import sphinx_bootstrap_theme

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.todo',
    'sphinx.ext.viewcode',
    'sphinxcontrib.napoleon']

templates_path = ['doc/_templates']
source_suffix = '.rst'
master_doc = 'readme'

# General information about the project.
project = "streamingtools"
copyright = "2019, Christian Schwarz"
author = "Christian Schwarz"

version = "0"
release = "1"

language = None

autosummary_generate = True
exclude_patterns = []
pygments_style = 'sphinx'

todo_include_todos = True

# -- Options for HTML output
html_theme = 'bootstrap'
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()

html_static_path = ['doc/_static']
html_logo = "doc/_static/logo.png"
html_favicon = "doc/_static/favicon.ico"
html_show_sphinx = False

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

# Bootstrap Template
html_theme_options = {
    "navbar_site_name": "Sub Pages",
    "navbar_sidebarrel": True,
    "navbar_pagenav": True,
    "navbar_pagenav_name": "This Page",

    "globaltoc_depth": 1,
    "globaltoc_includehidden": "true",
    "navbar_fixed_top": "true",
    "source_link_position": "nav",
    "bootstrap_version": "3",
}