GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.

conf   A
last analyzed

Complexity

Total Complexity 0

Size/Duplication

Total Lines 188
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
wmc 0
eloc 39
dl 0
loc 188
rs 10
c 0
b 0
f 0
1
# -*- coding: utf-8 -*-
2
#
3
# Configuration file for the Sphinx documentation builder.
4
#
5
# This file does only contain a selection of the most common options. For a
6
# full list see the documentation:
7
# http://www.sphinx-doc.org/en/master/config
8
9
# -- Path setup --------------------------------------------------------------
10
11
# If extensions (or modules to document with autodoc) are in another directory,
12
# add these directories to sys.path here. If the directory is relative to the
13
# documentation root, use os.path.abspath to make it absolute, like shown here.
14
#
15
import os
16
import sys
17
# sys.path.insert(0, os.path.abspath('.'))
18
sys.path.insert(0, os.path.abspath('../../'))
19
20
# -- Project information -----------------------------------------------------
21
22
project = 'BattDeg'
23
copyright = '2019, Chintan Pathak, Ge Gu, Guoyao Chen, Shrilakshmi Bonageri'
24
author = 'Chintan Pathak, Ge Gu, Guoyao Chen, Shrilakshmi Bonageri'
25
26
# The short X.Y version
27
version = ''
28
# The full version, including alpha/beta/rc tags
29
release = ''
30
31
32
# -- General configuration ---------------------------------------------------
33
34
# If your documentation needs a minimal Sphinx version, state it here.
35
#
36
# needs_sphinx = '1.0'
37
38
# Add any Sphinx extension module names here, as strings. They can be
39
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40
# ones.
41
extensions = [
42
    'sphinx.ext.autodoc',
43
    'sphinx.ext.todo',
44
    'sphinx.ext.coverage',
45
    'sphinx.ext.mathjax',
46
    'sphinx.ext.viewcode',
47
    'sphinx.ext.githubpages',
48
]
49
50
# Add any paths that contain templates here, relative to this directory.
51
templates_path = ['_templates']
52
53
# The suffix(es) of source filenames.
54
# You can specify multiple suffix as a list of string:
55
#
56
# source_suffix = ['.rst', '.md']
57
source_suffix = '.rst'
58
59
# The master toctree document.
60
master_doc = 'index'
61
62
# The language for content autogenerated by Sphinx. Refer to documentation
63
# for a list of supported languages.
64
#
65
# This is also used if you do content translation via gettext catalogs.
66
# Usually you set "language" from the command line for these cases.
67
language = None
68
69
# List of patterns, relative to source directory, that match files and
70
# directories to ignore when looking for source files.
71
# This pattern also affects html_static_path and html_extra_path.
72
exclude_patterns = []
73
74
# The name of the Pygments (syntax highlighting) style to use.
75
pygments_style = None
76
77
78
# -- Options for HTML output -------------------------------------------------
79
80
# The theme to use for HTML and HTML Help pages.  See the documentation for
81
# a list of builtin themes.
82
#
83
html_theme = 'alabaster'
84
85
# Theme options are theme-specific and customize the look and feel of a theme
86
# further.  For a list of options available for each theme, see the
87
# documentation.
88
#
89
# html_theme_options = {}
90
91
# Add any paths that contain custom static files (such as style sheets) here,
92
# relative to this directory. They are copied after the builtin static files,
93
# so a file named "default.css" will overwrite the builtin "default.css".
94
html_static_path = ['_static']
95
96
# Custom sidebar templates, must be a dictionary that maps document names
97
# to template names.
98
#
99
# The default sidebars (for documents that don't match any pattern) are
100
# defined by theme itself.  Builtin themes are using these templates by
101
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
102
# 'searchbox.html']``.
103
#
104
# html_sidebars = {}
105
106
107
# -- Options for HTMLHelp output ---------------------------------------------
108
109
# Output file base name for HTML help builder.
110
htmlhelp_basename = 'BattDegdoc'
111
112
113
# -- Options for LaTeX output ------------------------------------------------
114
115
latex_elements = {
116
    # The paper size ('letterpaper' or 'a4paper').
117
    #
118
    # 'papersize': 'letterpaper',
119
120
    # The font size ('10pt', '11pt' or '12pt').
121
    #
122
    # 'pointsize': '10pt',
123
124
    # Additional stuff for the LaTeX preamble.
125
    #
126
    # 'preamble': '',
127
128
    # Latex figure (float) alignment
129
    #
130
    # 'figure_align': 'htbp',
131
}
132
133
# Grouping the document tree into LaTeX files. List of tuples
134
# (source start file, target name, title,
135
#  author, documentclass [howto, manual, or own class]).
136
latex_documents = [
137
    (master_doc, 'BattDeg.tex', 'BattDeg Documentation',
138
     'Chintan Pathak, Ge Gu, Guoyao Chen, Shrilakshmi Bonageri', 'manual'),
139
]
140
141
142
# -- Options for manual page output ------------------------------------------
143
144
# One entry per manual page. List of tuples
145
# (source start file, name, description, authors, manual section).
146
man_pages = [
147
    (master_doc, 'battdeg', 'BattDeg Documentation',
148
     [author], 1)
149
]
150
151
152
# -- Options for Texinfo output ----------------------------------------------
153
154
# Grouping the document tree into Texinfo files. List of tuples
155
# (source start file, target name, title, author,
156
#  dir menu entry, description, category)
157
texinfo_documents = [
158
    (master_doc, 'BattDeg', 'BattDeg Documentation',
159
     author, 'BattDeg', 'One line description of project.',
160
     'Miscellaneous'),
161
]
162
163
164
# -- Options for Epub output -------------------------------------------------
165
166
# Bibliographic Dublin Core info.
167
epub_title = project
168
169
# The unique identifier of the text. This can be a ISBN number
170
# or the project homepage.
171
#
172
# epub_identifier = ''
173
174
# A unique identification for the text.
175
#
176
# epub_uid = ''
177
178
# A list of files that should not be packed into the epub file.
179
epub_exclude_files = ['search.html']
180
181
182
# -- Extension configuration -------------------------------------------------
183
184
# -- Options for todo extension ----------------------------------------------
185
186
# If true, `todo` and `todoList` produce output, else they produce nothing.
187
todo_include_todos = True
188