conf   A
last analyzed

Complexity

Total Complexity 0

Size/Duplication

Total Lines 173
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
wmc 0
eloc 29
dl 0
loc 173
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
19
20
# -- Project information -----------------------------------------------------
21
22
project = 'PyPen'
23
copyright = '2020, ErikWDev, cqann'
24
author = 'ErikWDev, cqann'
25
26
# The short X.Y version
27
version = ''
28
# The full version, including alpha/beta/rc tags
29
release = '0.1.0'
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
43
# Add any paths that contain templates here, relative to this directory.
44
templates_path = ['_templates']
45
46
# The suffix(es) of source filenames.
47
# You can specify multiple suffix as a list of string:
48
#
49
# source_suffix = ['.rst', '.md']
50
source_suffix = '.rst'
51
52
# The master toctree document.
53
master_doc = 'index'
54
55
# The language for content autogenerated by Sphinx. Refer to documentation
56
# for a list of supported languages.
57
#
58
# This is also used if you do content translation via gettext catalogs.
59
# Usually you set "language" from the command line for these cases.
60
language = None
61
62
# List of patterns, relative to source directory, that match files and
63
# directories to ignore when looking for source files.
64
# This pattern also affects html_static_path and html_extra_path.
65
exclude_patterns = []
66
67
# The name of the Pygments (syntax highlighting) style to use.
68
pygments_style = None
69
70
71
# -- Options for HTML output -------------------------------------------------
72
73
# The theme to use for HTML and HTML Help pages.  See the documentation for
74
# a list of builtin themes.
75
#
76
html_theme = 'sphinx_rtd_theme'
77
78
# Theme options are theme-specific and customize the look and feel of a theme
79
# further.  For a list of options available for each theme, see the
80
# documentation.
81
#
82
# html_theme_options = {}
83
84
# Add any paths that contain custom static files (such as style sheets) here,
85
# relative to this directory. They are copied after the builtin static files,
86
# so a file named "default.css" will overwrite the builtin "default.css".
87
html_static_path = ['resources']
88
89
# Custom sidebar templates, must be a dictionary that maps document names
90
# to template names.
91
#
92
# The default sidebars (for documents that don't match any pattern) are
93
# defined by theme itself.  Builtin themes are using these templates by
94
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
95
# 'searchbox.html']``.
96
#
97
# html_sidebars = {}
98
99
100
# -- Options for HTMLHelp output ---------------------------------------------
101
102
# Output file base name for HTML help builder.
103
htmlhelp_basename = 'PyPendoc'
104
105
106
# -- Options for LaTeX output ------------------------------------------------
107
108
latex_elements = {
109
    # The paper size ('letterpaper' or 'a4paper').
110
    #
111
    # 'papersize': 'letterpaper',
112
113
    # The font size ('10pt', '11pt' or '12pt').
114
    #
115
    # 'pointsize': '10pt',
116
117
    # Additional stuff for the LaTeX preamble.
118
    #
119
    # 'preamble': '',
120
121
    # Latex figure (float) alignment
122
    #
123
    # 'figure_align': 'htbp',
124
}
125
126
# Grouping the document tree into LaTeX files. List of tuples
127
# (source start file, target name, title,
128
#  author, documentclass [howto, manual, or own class]).
129
latex_documents = [
130
    (master_doc, 'PyPen.tex', 'PyPen Documentation',
131
     'ErikWDev, cqann', 'manual'),
132
]
133
134
135
# -- Options for manual page output ------------------------------------------
136
137
# One entry per manual page. List of tuples
138
# (source start file, name, description, authors, manual section).
139
man_pages = [
140
    (master_doc, 'pypen', 'PyPen Documentation',
141
     [author], 1)
142
]
143
144
145
# -- Options for Texinfo output ----------------------------------------------
146
147
# Grouping the document tree into Texinfo files. List of tuples
148
# (source start file, target name, title, author,
149
#  dir menu entry, description, category)
150
texinfo_documents = [
151
    (master_doc, 'PyPen', 'PyPen Documentation',
152
     author, 'PyPen', 'One line description of project.',
153
     'Miscellaneous'),
154
]
155
156
157
# -- Options for Epub output -------------------------------------------------
158
159
# Bibliographic Dublin Core info.
160
epub_title = project
161
162
# The unique identifier of the text. This can be a ISBN number
163
# or the project homepage.
164
#
165
# epub_identifier = ''
166
167
# A unique identification for the text.
168
#
169
# epub_uid = ''
170
171
# A list of files that should not be packed into the epub file.
172
epub_exclude_files = ['search.html']
173
174
175
# -- Extension configuration -------------------------------------------------
176