aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorjason2017-01-23 20:06:18 -0700
committerjason2017-01-24 10:13:40 -0700
commitb340ea15add30d136eb46b8998aee0ffb1a72115 (patch)
tree9e709a101adf8b3a804400a770565edf202e6651 /docs
parent1d9e4e103bd611cda4f3208d8c0921f6859729dd (diff)
downloadeventmq-b340ea15add30d136eb46b8998aee0ffb1a72115.tar.gz
eventmq-b340ea15add30d136eb46b8998aee0ffb1a72115.zip
Update the pep8 goodness and test with circle and flake8
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py109
1 files changed, 52 insertions, 57 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 1e28fa9..7cc2c14 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -11,21 +11,16 @@
11# 11#
12# All configuration values have a default; values that are commented out 12# All configuration values have a default; values that are commented out
13# serve to show the default. 13# serve to show the default.
14
15import sys
16import os
17import shlex
18
19import eventmq # for __version__ 14import eventmq # for __version__
20# If extensions (or modules to document with autodoc) are in another directory, 15# If extensions (or modules to document with autodoc) are in another directory,
21# add these directories to sys.path here. If the directory is relative to the 16# add these directories to sys.path here. If the directory is relative to the
22# documentation root, use os.path.abspath to make it absolute, like shown here. 17# documentation root, use os.path.abspath to make it absolute, like shown here.
23#sys.path.insert(0, os.path.abspath('.')) 18# sys.path.insert(0, os.path.abspath('.'))
24 19
25# -- General configuration ------------------------------------------------ 20# -- General configuration ------------------------------------------------
26 21
27# If your documentation needs a minimal Sphinx version, state it here. 22# If your documentation needs a minimal Sphinx version, state it here.
28#needs_sphinx = '1.0' 23# needs_sphinx = '1.0'
29 24
30# Add any Sphinx extension module names here, as strings. They can be 25# Add any Sphinx extension module names here, as strings. They can be
31# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 26# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -46,7 +41,7 @@ templates_path = ['_templates']
46source_suffix = '.rst' 41source_suffix = '.rst'
47 42
48# The encoding of source files. 43# The encoding of source files.
49#source_encoding = 'utf-8-sig' 44# source_encoding = 'utf-8-sig'
50 45
51# The master toctree document. 46# The master toctree document.
52master_doc = 'index' 47master_doc = 'index'
@@ -74,9 +69,9 @@ language = None
74 69
75# There are two options for replacing |today|: either, you set today to some 70# There are two options for replacing |today|: either, you set today to some
76# non-false value, then it is used: 71# non-false value, then it is used:
77#today = '' 72# today = ''
78# Else, today_fmt is used as the format for a strftime call. 73# Else, today_fmt is used as the format for a strftime call.
79#today_fmt = '%B %d, %Y' 74# today_fmt = '%B %d, %Y'
80 75
81# List of patterns, relative to source directory, that match files and 76# List of patterns, relative to source directory, that match files and
82# directories to ignore when looking for source files. 77# directories to ignore when looking for source files.
@@ -84,27 +79,27 @@ exclude_patterns = ['_build']
84 79
85# The reST default role (used for this markup: `text`) to use for all 80# The reST default role (used for this markup: `text`) to use for all
86# documents. 81# documents.
87#default_role = None 82# default_role = None
88 83
89# If true, '()' will be appended to :func: etc. cross-reference text. 84# If true, '()' will be appended to :func: etc. cross-reference text.
90#add_function_parentheses = True 85# add_function_parentheses = True
91 86
92# If true, the current module name will be prepended to all description 87# If true, the current module name will be prepended to all description
93# unit titles (such as .. function::). 88# unit titles (such as .. function::).
94#add_module_names = True 89# add_module_names = True
95 90
96# If true, sectionauthor and moduleauthor directives will be shown in the 91# If true, sectionauthor and moduleauthor directives will be shown in the
97# output. They are ignored by default. 92# output. They are ignored by default.
98#show_authors = False 93# show_authors = False
99 94
100# The name of the Pygments (syntax highlighting) style to use. 95# The name of the Pygments (syntax highlighting) style to use.
101pygments_style = 'sphinx' 96pygments_style = 'sphinx'
102 97
103# A list of ignored prefixes for module index sorting. 98# A list of ignored prefixes for module index sorting.
104#modindex_common_prefix = [] 99# modindex_common_prefix = []
105 100
106# If true, keep warnings as "system message" paragraphs in the built documents. 101# If true, keep warnings as "system message" paragraphs in the built documents.
107#keep_warnings = False 102# keep_warnings = False
108 103
109# If true, `todo` and `todoList` produce output, else they produce nothing. 104# If true, `todo` and `todoList` produce output, else they produce nothing.
110todo_include_todos = False 105todo_include_todos = False
@@ -119,26 +114,26 @@ html_theme = 'sphinx_rtd_theme'
119# Theme options are theme-specific and customize the look and feel of a theme 114# Theme options are theme-specific and customize the look and feel of a theme
120# further. For a list of options available for each theme, see the 115# further. For a list of options available for each theme, see the
121# documentation. 116# documentation.
122#html_theme_options = {} 117# html_theme_options = {}
123 118
124# Add any paths that contain custom themes here, relative to this directory. 119# Add any paths that contain custom themes here, relative to this directory.
125#html_theme_path = [] 120# html_theme_path = []
126 121
127# The name for this set of Sphinx documents. If None, it defaults to 122# The name for this set of Sphinx documents. If None, it defaults to
128# "<project> v<release> documentation". 123# "<project> v<release> documentation".
129#html_title = None 124# html_title = None
130 125
131# A shorter title for the navigation bar. Default is the same as html_title. 126# A shorter title for the navigation bar. Default is the same as html_title.
132#html_short_title = None 127# html_short_title = None
133 128
134# The name of an image file (relative to this directory) to place at the top 129# The name of an image file (relative to this directory) to place at the top
135# of the sidebar. 130# of the sidebar.
136#html_logo = None 131# html_logo = None
137 132
138# The name of an image file (within the static path) to use as favicon of the 133# The name of an image file (within the static path) to use as favicon of the
139# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 134# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
140# pixels large. 135# pixels large.
141#html_favicon = None 136# html_favicon = None
142 137
143# Add any paths that contain custom static files (such as style sheets) here, 138# Add any paths that contain custom static files (such as style sheets) here,
144# relative to this directory. They are copied after the builtin static files, 139# relative to this directory. They are copied after the builtin static files,
@@ -148,62 +143,62 @@ html_static_path = ['_static']
148# Add any extra paths that contain custom files (such as robots.txt or 143# Add any extra paths that contain custom files (such as robots.txt or
149# .htaccess) here, relative to this directory. These files are copied 144# .htaccess) here, relative to this directory. These files are copied
150# directly to the root of the documentation. 145# directly to the root of the documentation.
151#html_extra_path = [] 146# html_extra_path = []
152 147
153# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 148# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
154# using the given strftime format. 149# using the given strftime format.
155#html_last_updated_fmt = '%b %d, %Y' 150# html_last_updated_fmt = '%b %d, %Y'
156 151
157# If true, SmartyPants will be used to convert quotes and dashes to 152# If true, SmartyPants will be used to convert quotes and dashes to
158# typographically correct entities. 153# typographically correct entities.
159#html_use_smartypants = True 154# html_use_smartypants = True
160 155
161# Custom sidebar templates, maps document names to template names. 156# Custom sidebar templates, maps document names to template names.
162#html_sidebars = {} 157# html_sidebars = {}
163 158
164# Additional templates that should be rendered to pages, maps page names to 159# Additional templates that should be rendered to pages, maps page names to
165# template names. 160# template names.
166#html_additional_pages = {} 161# html_additional_pages = {}
167 162
168# If false, no module index is generated. 163# If false, no module index is generated.
169#html_domain_indices = True 164# html_domain_indices = True
170 165
171# If false, no index is generated. 166# If false, no index is generated.
172#html_use_index = True 167# html_use_index = True
173 168
174# If true, the index is split into individual pages for each letter. 169# If true, the index is split into individual pages for each letter.
175#html_split_index = False 170# html_split_index = False
176 171
177# If true, links to the reST sources are added to the pages. 172# If true, links to the reST sources are added to the pages.
178#html_show_sourcelink = True 173# html_show_sourcelink = True
179 174
180# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 175# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
181#html_show_sphinx = True 176# html_show_sphinx = True
182 177
183# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 178# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
184#html_show_copyright = True 179# html_show_copyright = True
185 180
186# If true, an OpenSearch description file will be output, and all pages will 181# If true, an OpenSearch description file will be output, and all pages will
187# contain a <link> tag referring to it. The value of this option must be the 182# contain a <link> tag referring to it. The value of this option must be the
188# base URL from which the finished HTML is served. 183# base URL from which the finished HTML is served.
189#html_use_opensearch = '' 184# html_use_opensearch = ''
190 185
191# This is the file name suffix for HTML files (e.g. ".xhtml"). 186# This is the file name suffix for HTML files (e.g. ".xhtml").
192#html_file_suffix = None 187# html_file_suffix = None
193 188
194# Language to be used for generating the HTML full-text search index. 189# Language to be used for generating the HTML full-text search index.
195# Sphinx supports the following languages: 190# Sphinx supports the following languages:
196# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' 191# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
197# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' 192# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
198#html_search_language = 'en' 193# html_search_language = 'en'
199 194
200# A dictionary with options for the search language support, empty by default. 195# A dictionary with options for the search language support, empty by default.
201# Now only 'ja' uses this config value 196# Now only 'ja' uses this config value
202#html_search_options = {'type': 'default'} 197# html_search_options = {'type': 'default'}
203 198
204# The name of a javascript file (relative to the configuration directory) that 199# The name of a javascript file (relative to the configuration directory) that
205# implements a search results scorer. If empty, the default will be used. 200# implements a search results scorer. If empty, the default will be used.
206#html_search_scorer = 'scorer.js' 201# html_search_scorer = 'scorer.js'
207 202
208# Output file base name for HTML help builder. 203# Output file base name for HTML help builder.
209htmlhelp_basename = 'EventMQdoc' 204htmlhelp_basename = 'EventMQdoc'
@@ -211,17 +206,17 @@ htmlhelp_basename = 'EventMQdoc'
211# -- Options for LaTeX output --------------------------------------------- 206# -- Options for LaTeX output ---------------------------------------------
212 207
213latex_elements = { 208latex_elements = {
214# The paper size ('letterpaper' or 'a4paper'). 209 # The paper size ('letterpaper' or 'a4paper').
215#'papersize': 'letterpaper', 210 # 'papersize': 'letterpaper',
216 211
217# The font size ('10pt', '11pt' or '12pt'). 212 # The font size ('10pt', '11pt' or '12pt').
218#'pointsize': '10pt', 213 # 'pointsize': '10pt',
219 214
220# Additional stuff for the LaTeX preamble. 215 # Additional stuff for the LaTeX preamble.
221#'preamble': '', 216 # 'preamble': '',
222 217
223# Latex figure (float) alignment 218 # Latex figure (float) alignment
224#'figure_align': 'htbp', 219 # 'figure_align': 'htbp',
225} 220}
226 221
227# Grouping the document tree into LaTeX files. List of tuples 222# Grouping the document tree into LaTeX files. List of tuples
@@ -234,23 +229,23 @@ latex_documents = [
234 229
235# The name of an image file (relative to this directory) to place at the top of 230# The name of an image file (relative to this directory) to place at the top of
236# the title page. 231# the title page.
237#latex_logo = None 232# latex_logo = None
238 233
239# For "manual" documents, if this is true, then toplevel headings are parts, 234# For "manual" documents, if this is true, then toplevel headings are parts,
240# not chapters. 235# not chapters.
241#latex_use_parts = False 236# latex_use_parts = False
242 237
243# If true, show page references after internal links. 238# If true, show page references after internal links.
244#latex_show_pagerefs = False 239# latex_show_pagerefs = False
245 240
246# If true, show URL addresses after external links. 241# If true, show URL addresses after external links.
247#latex_show_urls = False 242# latex_show_urls = False
248 243
249# Documents to append as an appendix to all manuals. 244# Documents to append as an appendix to all manuals.
250#latex_appendices = [] 245# latex_appendices = []
251 246
252# If false, no module index is generated. 247# If false, no module index is generated.
253#latex_domain_indices = True 248# latex_domain_indices = True
254 249
255 250
256# -- Options for manual page output --------------------------------------- 251# -- Options for manual page output ---------------------------------------
@@ -263,7 +258,7 @@ man_pages = [
263] 258]
264 259
265# If true, show URL addresses after external links. 260# If true, show URL addresses after external links.
266#man_show_urls = False 261# man_show_urls = False
267 262
268 263
269# -- Options for Texinfo output ------------------------------------------- 264# -- Options for Texinfo output -------------------------------------------
@@ -278,16 +273,16 @@ texinfo_documents = [
278] 273]
279 274
280# Documents to append as an appendix to all manuals. 275# Documents to append as an appendix to all manuals.
281#texinfo_appendices = [] 276# texinfo_appendices = []
282 277
283# If false, no module index is generated. 278# If false, no module index is generated.
284#texinfo_domain_indices = True 279# texinfo_domain_indices = True
285 280
286# How to display URL addresses: 'footnote', 'no', or 'inline'. 281# How to display URL addresses: 'footnote', 'no', or 'inline'.
287#texinfo_show_urls = 'footnote' 282# texinfo_show_urls = 'footnote'
288 283
289# If true, do not generate a @detailmenu in the "Top" node's menu. 284# If true, do not generate a @detailmenu in the "Top" node's menu.
290#texinfo_no_detailmenu = False 285# texinfo_no_detailmenu = False
291 286
292 287
293# Example configuration for intersphinx: refer to the Python standard library. 288# Example configuration for intersphinx: refer to the Python standard library.