Skip to content

Commit 8b694b8

Browse files
committed
Re-formatted Python files using black
1 parent 9db2ead commit 8b694b8

File tree

5 files changed

+244
-214
lines changed

5 files changed

+244
-214
lines changed

docs/conf.py

+76-68
Original file line numberDiff line numberDiff line change
@@ -17,210 +17,212 @@
1717
# If extensions (or modules to document with autodoc) are in another directory,
1818
# add these directories to sys.path here. If the directory is relative to the
1919
# documentation root, use os.path.abspath to make it absolute, like shown here.
20-
#sys.path.insert(0, os.path.abspath('.'))
21-
sys.path.insert(0, os.path.abspath('../'))
20+
# sys.path.insert(0, os.path.abspath('.'))
21+
sys.path.insert(0, os.path.abspath("../"))
2222

2323
# -- General configuration -----------------------------------------------------
2424

2525
# If your documentation needs a minimal Sphinx version, state it here.
26-
#needs_sphinx = '1.0'
26+
# needs_sphinx = '1.0'
2727

2828
# Add any Sphinx extension module names here, as strings. They can be extensions
2929
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage']
30+
extensions = ["sphinx.ext.autodoc", "sphinx.ext.coverage"]
3131

3232
# Add any paths that contain templates here, relative to this directory.
33-
templates_path = ['_templates']
33+
templates_path = ["_templates"]
3434

3535
# The suffix of source filenames.
36-
source_suffix = '.rst'
36+
source_suffix = ".rst"
3737

3838
# The encoding of source files.
39-
#source_encoding = 'utf-8-sig'
39+
# source_encoding = 'utf-8-sig'
4040

4141
# The master toctree document.
42-
master_doc = 'index'
42+
master_doc = "index"
4343

4444
# General information about the project.
45-
project = 'libgravatar'
46-
copyright = '2013, Pablo SEMINARIO'
45+
project = "libgravatar"
46+
copyright = "2013, Pablo SEMINARIO"
4747

4848
# The version info for the project you're documenting, acts as replacement for
4949
# |version| and |release|, also used in various other places throughout the
5050
# built documents.
5151
#
5252
# The short X.Y version.
53-
version = '0.2.5'
53+
version = "0.2.5"
5454
# The full version, including alpha/beta/rc tags.
55-
release = '0.2.5'
55+
release = "0.2.5"
5656

5757
# The language for content autogenerated by Sphinx. Refer to documentation
5858
# for a list of supported languages.
59-
#language = None
59+
# language = None
6060

6161
# There are two options for replacing |today|: either, you set today to some
6262
# non-false value, then it is used:
63-
#today = ''
63+
# today = ''
6464
# Else, today_fmt is used as the format for a strftime call.
65-
#today_fmt = '%B %d, %Y'
65+
# today_fmt = '%B %d, %Y'
6666

6767
# List of patterns, relative to source directory, that match files and
6868
# directories to ignore when looking for source files.
69-
exclude_patterns = ['_build']
69+
exclude_patterns = ["_build"]
7070

7171
# The reST default role (used for this markup: `text`) to use for all documents.
72-
#default_role = None
72+
# default_role = None
7373

7474
# If true, '()' will be appended to :func: etc. cross-reference text.
75-
#add_function_parentheses = True
75+
# add_function_parentheses = True
7676

7777
# If true, the current module name will be prepended to all description
7878
# unit titles (such as .. function::).
79-
#add_module_names = True
79+
# add_module_names = True
8080

8181
# If true, sectionauthor and moduleauthor directives will be shown in the
8282
# output. They are ignored by default.
83-
#show_authors = False
83+
# show_authors = False
8484

8585
# The name of the Pygments (syntax highlighting) style to use.
86-
pygments_style = 'sphinx'
86+
pygments_style = "sphinx"
8787

8888
# A list of ignored prefixes for module index sorting.
89-
#modindex_common_prefix = []
89+
# modindex_common_prefix = []
9090

9191

9292
# -- Options for HTML output ---------------------------------------------------
9393

9494
# The theme to use for HTML and HTML Help pages. See the documentation for
9595
# a list of builtin themes.
96-
html_theme = 'default'
96+
html_theme = "default"
9797

9898
# Theme options are theme-specific and customize the look and feel of a theme
9999
# further. For a list of options available for each theme, see the
100100
# documentation.
101-
#html_theme_options = {}
101+
# html_theme_options = {}
102102

103103
# Add any paths that contain custom themes here, relative to this directory.
104-
#html_theme_path = []
104+
# html_theme_path = []
105105

106106
# The name for this set of Sphinx documents. If None, it defaults to
107107
# "<project> v<release> documentation".
108-
#html_title = None
108+
# html_title = None
109109

110110
# A shorter title for the navigation bar. Default is the same as html_title.
111-
#html_short_title = None
111+
# html_short_title = None
112112

113113
# The name of an image file (relative to this directory) to place at the top
114114
# of the sidebar.
115-
#html_logo = None
115+
# html_logo = None
116116

117117
# The name of an image file (within the static path) to use as favicon of the
118118
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
119119
# pixels large.
120-
#html_favicon = None
120+
# html_favicon = None
121121

122122
# Add any paths that contain custom static files (such as style sheets) here,
123123
# relative to this directory. They are copied after the builtin static files,
124124
# so a file named "default.css" will overwrite the builtin "default.css".
125-
html_static_path = ['_static']
125+
html_static_path = ["_static"]
126126

127127
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128128
# using the given strftime format.
129-
#html_last_updated_fmt = '%b %d, %Y'
129+
# html_last_updated_fmt = '%b %d, %Y'
130130

131131
# If true, SmartyPants will be used to convert quotes and dashes to
132132
# typographically correct entities.
133-
#html_use_smartypants = True
133+
# html_use_smartypants = True
134134

135135
# Custom sidebar templates, maps document names to template names.
136-
#html_sidebars = {}
136+
# html_sidebars = {}
137137

138138
# Additional templates that should be rendered to pages, maps page names to
139139
# template names.
140-
#html_additional_pages = {}
140+
# html_additional_pages = {}
141141

142142
# If false, no module index is generated.
143-
#html_domain_indices = True
143+
# html_domain_indices = True
144144

145145
# If false, no index is generated.
146-
#html_use_index = True
146+
# html_use_index = True
147147

148148
# If true, the index is split into individual pages for each letter.
149-
#html_split_index = False
149+
# html_split_index = False
150150

151151
# If true, links to the reST sources are added to the pages.
152-
#html_show_sourcelink = True
152+
# html_show_sourcelink = True
153153

154154
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
155-
#html_show_sphinx = True
155+
# html_show_sphinx = True
156156

157157
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
158-
#html_show_copyright = True
158+
# html_show_copyright = True
159159

160160
# If true, an OpenSearch description file will be output, and all pages will
161161
# contain a <link> tag referring to it. The value of this option must be the
162162
# base URL from which the finished HTML is served.
163-
#html_use_opensearch = ''
163+
# html_use_opensearch = ''
164164

165165
# This is the file name suffix for HTML files (e.g. ".xhtml").
166-
#html_file_suffix = None
166+
# html_file_suffix = None
167167

168168
# Output file base name for HTML help builder.
169-
htmlhelp_basename = 'libgravatardoc'
169+
htmlhelp_basename = "libgravatardoc"
170170

171171

172172
# -- Options for LaTeX output --------------------------------------------------
173173

174174
latex_elements = {
175-
# The paper size ('letterpaper' or 'a4paper').
176-
#'papersize': 'letterpaper',
177-
178-
# The font size ('10pt', '11pt' or '12pt').
179-
#'pointsize': '10pt',
180-
181-
# Additional stuff for the LaTeX preamble.
182-
#'preamble': '',
175+
# The paper size ('letterpaper' or 'a4paper').
176+
#'papersize': 'letterpaper',
177+
# The font size ('10pt', '11pt' or '12pt').
178+
#'pointsize': '10pt',
179+
# Additional stuff for the LaTeX preamble.
180+
#'preamble': '',
183181
}
184182

185183
# Grouping the document tree into LaTeX files. List of tuples
186184
# (source start file, target name, title, author, documentclass [howto/manual]).
187185
latex_documents = [
188-
('index', 'libgravatar.tex', 'libgravatar Documentation',
189-
'Pablo SEMINARIO', 'manual'),
186+
(
187+
"index",
188+
"libgravatar.tex",
189+
"libgravatar Documentation",
190+
"Pablo SEMINARIO",
191+
"manual",
192+
),
190193
]
191194

192195
# The name of an image file (relative to this directory) to place at the top of
193196
# the title page.
194-
#latex_logo = None
197+
# latex_logo = None
195198

196199
# For "manual" documents, if this is true, then toplevel headings are parts,
197200
# not chapters.
198-
#latex_use_parts = False
201+
# latex_use_parts = False
199202

200203
# If true, show page references after internal links.
201-
#latex_show_pagerefs = False
204+
# latex_show_pagerefs = False
202205

203206
# If true, show URL addresses after external links.
204-
#latex_show_urls = False
207+
# latex_show_urls = False
205208

206209
# Documents to append as an appendix to all manuals.
207-
#latex_appendices = []
210+
# latex_appendices = []
208211

209212
# If false, no module index is generated.
210-
#latex_domain_indices = True
213+
# latex_domain_indices = True
211214

212215

213216
# -- Options for manual page output --------------------------------------------
214217

215218
# One entry per manual page. List of tuples
216219
# (source start file, name, description, authors, manual section).
217220
man_pages = [
218-
('index', 'libgravatar', 'libgravatar Documentation',
219-
['Pablo SEMINARIO'], 1)
221+
("index", "libgravatar", "libgravatar Documentation", ["Pablo SEMINARIO"], 1)
220222
]
221223

222224
# If true, show URL addresses after external links.
223-
#man_show_urls = False
225+
# man_show_urls = False
224226

225227

226228
# -- Options for Texinfo output ------------------------------------------------
@@ -229,16 +231,22 @@
229231
# (source start file, target name, title, author,
230232
# dir menu entry, description, category)
231233
texinfo_documents = [
232-
('index', 'libgravatar', 'libgravatar Documentation',
233-
'Pablo SEMINARIO', 'libgravatar', 'One line description of project.',
234-
'Miscellaneous'),
234+
(
235+
"index",
236+
"libgravatar",
237+
"libgravatar Documentation",
238+
"Pablo SEMINARIO",
239+
"libgravatar",
240+
"One line description of project.",
241+
"Miscellaneous",
242+
),
235243
]
236244

237245
# Documents to append as an appendix to all manuals.
238-
#texinfo_appendices = []
246+
# texinfo_appendices = []
239247

240248
# If false, no module index is generated.
241-
#texinfo_domain_indices = True
249+
# texinfo_domain_indices = True
242250

243251
# How to display URL addresses: 'footnote', 'no', or 'inline'.
244-
#texinfo_show_urls = 'footnote'
252+
# texinfo_show_urls = 'footnote'

0 commit comments

Comments
 (0)