|
17 | 17 | # If extensions (or modules to document with autodoc) are in another directory,
|
18 | 18 | # add these directories to sys.path here. If the directory is relative to the
|
19 | 19 | # 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("../")) |
22 | 22 |
|
23 | 23 | # -- General configuration -----------------------------------------------------
|
24 | 24 |
|
25 | 25 | # If your documentation needs a minimal Sphinx version, state it here.
|
26 |
| -#needs_sphinx = '1.0' |
| 26 | +# needs_sphinx = '1.0' |
27 | 27 |
|
28 | 28 | # Add any Sphinx extension module names here, as strings. They can be extensions
|
29 | 29 | # 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"] |
31 | 31 |
|
32 | 32 | # Add any paths that contain templates here, relative to this directory.
|
33 |
| -templates_path = ['_templates'] |
| 33 | +templates_path = ["_templates"] |
34 | 34 |
|
35 | 35 | # The suffix of source filenames.
|
36 |
| -source_suffix = '.rst' |
| 36 | +source_suffix = ".rst" |
37 | 37 |
|
38 | 38 | # The encoding of source files.
|
39 |
| -#source_encoding = 'utf-8-sig' |
| 39 | +# source_encoding = 'utf-8-sig' |
40 | 40 |
|
41 | 41 | # The master toctree document.
|
42 |
| -master_doc = 'index' |
| 42 | +master_doc = "index" |
43 | 43 |
|
44 | 44 | # General information about the project.
|
45 |
| -project = 'libgravatar' |
46 |
| -copyright = '2013, Pablo SEMINARIO' |
| 45 | +project = "libgravatar" |
| 46 | +copyright = "2013, Pablo SEMINARIO" |
47 | 47 |
|
48 | 48 | # The version info for the project you're documenting, acts as replacement for
|
49 | 49 | # |version| and |release|, also used in various other places throughout the
|
50 | 50 | # built documents.
|
51 | 51 | #
|
52 | 52 | # The short X.Y version.
|
53 |
| -version = '0.2.5' |
| 53 | +version = "0.2.5" |
54 | 54 | # The full version, including alpha/beta/rc tags.
|
55 |
| -release = '0.2.5' |
| 55 | +release = "0.2.5" |
56 | 56 |
|
57 | 57 | # The language for content autogenerated by Sphinx. Refer to documentation
|
58 | 58 | # for a list of supported languages.
|
59 |
| -#language = None |
| 59 | +# language = None |
60 | 60 |
|
61 | 61 | # There are two options for replacing |today|: either, you set today to some
|
62 | 62 | # non-false value, then it is used:
|
63 |
| -#today = '' |
| 63 | +# today = '' |
64 | 64 | # Else, today_fmt is used as the format for a strftime call.
|
65 |
| -#today_fmt = '%B %d, %Y' |
| 65 | +# today_fmt = '%B %d, %Y' |
66 | 66 |
|
67 | 67 | # List of patterns, relative to source directory, that match files and
|
68 | 68 | # directories to ignore when looking for source files.
|
69 |
| -exclude_patterns = ['_build'] |
| 69 | +exclude_patterns = ["_build"] |
70 | 70 |
|
71 | 71 | # The reST default role (used for this markup: `text`) to use for all documents.
|
72 |
| -#default_role = None |
| 72 | +# default_role = None |
73 | 73 |
|
74 | 74 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
75 |
| -#add_function_parentheses = True |
| 75 | +# add_function_parentheses = True |
76 | 76 |
|
77 | 77 | # If true, the current module name will be prepended to all description
|
78 | 78 | # unit titles (such as .. function::).
|
79 |
| -#add_module_names = True |
| 79 | +# add_module_names = True |
80 | 80 |
|
81 | 81 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
82 | 82 | # output. They are ignored by default.
|
83 |
| -#show_authors = False |
| 83 | +# show_authors = False |
84 | 84 |
|
85 | 85 | # The name of the Pygments (syntax highlighting) style to use.
|
86 |
| -pygments_style = 'sphinx' |
| 86 | +pygments_style = "sphinx" |
87 | 87 |
|
88 | 88 | # A list of ignored prefixes for module index sorting.
|
89 |
| -#modindex_common_prefix = [] |
| 89 | +# modindex_common_prefix = [] |
90 | 90 |
|
91 | 91 |
|
92 | 92 | # -- Options for HTML output ---------------------------------------------------
|
93 | 93 |
|
94 | 94 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
95 | 95 | # a list of builtin themes.
|
96 |
| -html_theme = 'default' |
| 96 | +html_theme = "default" |
97 | 97 |
|
98 | 98 | # Theme options are theme-specific and customize the look and feel of a theme
|
99 | 99 | # further. For a list of options available for each theme, see the
|
100 | 100 | # documentation.
|
101 |
| -#html_theme_options = {} |
| 101 | +# html_theme_options = {} |
102 | 102 |
|
103 | 103 | # Add any paths that contain custom themes here, relative to this directory.
|
104 |
| -#html_theme_path = [] |
| 104 | +# html_theme_path = [] |
105 | 105 |
|
106 | 106 | # The name for this set of Sphinx documents. If None, it defaults to
|
107 | 107 | # "<project> v<release> documentation".
|
108 |
| -#html_title = None |
| 108 | +# html_title = None |
109 | 109 |
|
110 | 110 | # A shorter title for the navigation bar. Default is the same as html_title.
|
111 |
| -#html_short_title = None |
| 111 | +# html_short_title = None |
112 | 112 |
|
113 | 113 | # The name of an image file (relative to this directory) to place at the top
|
114 | 114 | # of the sidebar.
|
115 |
| -#html_logo = None |
| 115 | +# html_logo = None |
116 | 116 |
|
117 | 117 | # The name of an image file (within the static path) to use as favicon of the
|
118 | 118 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
119 | 119 | # pixels large.
|
120 |
| -#html_favicon = None |
| 120 | +# html_favicon = None |
121 | 121 |
|
122 | 122 | # Add any paths that contain custom static files (such as style sheets) here,
|
123 | 123 | # relative to this directory. They are copied after the builtin static files,
|
124 | 124 | # so a file named "default.css" will overwrite the builtin "default.css".
|
125 |
| -html_static_path = ['_static'] |
| 125 | +html_static_path = ["_static"] |
126 | 126 |
|
127 | 127 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
128 | 128 | # using the given strftime format.
|
129 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 129 | +# html_last_updated_fmt = '%b %d, %Y' |
130 | 130 |
|
131 | 131 | # If true, SmartyPants will be used to convert quotes and dashes to
|
132 | 132 | # typographically correct entities.
|
133 |
| -#html_use_smartypants = True |
| 133 | +# html_use_smartypants = True |
134 | 134 |
|
135 | 135 | # Custom sidebar templates, maps document names to template names.
|
136 |
| -#html_sidebars = {} |
| 136 | +# html_sidebars = {} |
137 | 137 |
|
138 | 138 | # Additional templates that should be rendered to pages, maps page names to
|
139 | 139 | # template names.
|
140 |
| -#html_additional_pages = {} |
| 140 | +# html_additional_pages = {} |
141 | 141 |
|
142 | 142 | # If false, no module index is generated.
|
143 |
| -#html_domain_indices = True |
| 143 | +# html_domain_indices = True |
144 | 144 |
|
145 | 145 | # If false, no index is generated.
|
146 |
| -#html_use_index = True |
| 146 | +# html_use_index = True |
147 | 147 |
|
148 | 148 | # If true, the index is split into individual pages for each letter.
|
149 |
| -#html_split_index = False |
| 149 | +# html_split_index = False |
150 | 150 |
|
151 | 151 | # If true, links to the reST sources are added to the pages.
|
152 |
| -#html_show_sourcelink = True |
| 152 | +# html_show_sourcelink = True |
153 | 153 |
|
154 | 154 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
155 |
| -#html_show_sphinx = True |
| 155 | +# html_show_sphinx = True |
156 | 156 |
|
157 | 157 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
158 |
| -#html_show_copyright = True |
| 158 | +# html_show_copyright = True |
159 | 159 |
|
160 | 160 | # If true, an OpenSearch description file will be output, and all pages will
|
161 | 161 | # contain a <link> tag referring to it. The value of this option must be the
|
162 | 162 | # base URL from which the finished HTML is served.
|
163 |
| -#html_use_opensearch = '' |
| 163 | +# html_use_opensearch = '' |
164 | 164 |
|
165 | 165 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
166 |
| -#html_file_suffix = None |
| 166 | +# html_file_suffix = None |
167 | 167 |
|
168 | 168 | # Output file base name for HTML help builder.
|
169 |
| -htmlhelp_basename = 'libgravatardoc' |
| 169 | +htmlhelp_basename = "libgravatardoc" |
170 | 170 |
|
171 | 171 |
|
172 | 172 | # -- Options for LaTeX output --------------------------------------------------
|
173 | 173 |
|
174 | 174 | 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': '', |
183 | 181 | }
|
184 | 182 |
|
185 | 183 | # Grouping the document tree into LaTeX files. List of tuples
|
186 | 184 | # (source start file, target name, title, author, documentclass [howto/manual]).
|
187 | 185 | 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 | + ), |
190 | 193 | ]
|
191 | 194 |
|
192 | 195 | # The name of an image file (relative to this directory) to place at the top of
|
193 | 196 | # the title page.
|
194 |
| -#latex_logo = None |
| 197 | +# latex_logo = None |
195 | 198 |
|
196 | 199 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
197 | 200 | # not chapters.
|
198 |
| -#latex_use_parts = False |
| 201 | +# latex_use_parts = False |
199 | 202 |
|
200 | 203 | # If true, show page references after internal links.
|
201 |
| -#latex_show_pagerefs = False |
| 204 | +# latex_show_pagerefs = False |
202 | 205 |
|
203 | 206 | # If true, show URL addresses after external links.
|
204 |
| -#latex_show_urls = False |
| 207 | +# latex_show_urls = False |
205 | 208 |
|
206 | 209 | # Documents to append as an appendix to all manuals.
|
207 |
| -#latex_appendices = [] |
| 210 | +# latex_appendices = [] |
208 | 211 |
|
209 | 212 | # If false, no module index is generated.
|
210 |
| -#latex_domain_indices = True |
| 213 | +# latex_domain_indices = True |
211 | 214 |
|
212 | 215 |
|
213 | 216 | # -- Options for manual page output --------------------------------------------
|
214 | 217 |
|
215 | 218 | # One entry per manual page. List of tuples
|
216 | 219 | # (source start file, name, description, authors, manual section).
|
217 | 220 | man_pages = [
|
218 |
| - ('index', 'libgravatar', 'libgravatar Documentation', |
219 |
| - ['Pablo SEMINARIO'], 1) |
| 221 | + ("index", "libgravatar", "libgravatar Documentation", ["Pablo SEMINARIO"], 1) |
220 | 222 | ]
|
221 | 223 |
|
222 | 224 | # If true, show URL addresses after external links.
|
223 |
| -#man_show_urls = False |
| 225 | +# man_show_urls = False |
224 | 226 |
|
225 | 227 |
|
226 | 228 | # -- Options for Texinfo output ------------------------------------------------
|
|
229 | 231 | # (source start file, target name, title, author,
|
230 | 232 | # dir menu entry, description, category)
|
231 | 233 | 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 | + ), |
235 | 243 | ]
|
236 | 244 |
|
237 | 245 | # Documents to append as an appendix to all manuals.
|
238 |
| -#texinfo_appendices = [] |
| 246 | +# texinfo_appendices = [] |
239 | 247 |
|
240 | 248 | # If false, no module index is generated.
|
241 |
| -#texinfo_domain_indices = True |
| 249 | +# texinfo_domain_indices = True |
242 | 250 |
|
243 | 251 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
244 |
| -#texinfo_show_urls = 'footnote' |
| 252 | +# texinfo_show_urls = 'footnote' |
0 commit comments