|
18 | 18 | # If extensions (or modules to document with autodoc) are in another directory,
|
19 | 19 | # add these directories to sys.path here. If the directory is relative to the
|
20 | 20 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
21 |
| -sys.path.insert(0, os.path.abspath(os.path.join('..', 'src'))) |
| 21 | +sys.path.insert(0, os.path.abspath(os.path.join("..", "src"))) |
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 | 30 | extensions = []
|
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 = u'django-robots' |
46 |
| -copyright = u'2008-2016, Jannis Leidel' |
| 45 | +project = u"django-robots" |
| 46 | +copyright = u"2008-2016, Jannis Leidel" |
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
|
|
57 | 57 |
|
58 | 58 | # The language for content autogenerated by Sphinx. Refer to documentation
|
59 | 59 | # for a list of supported languages.
|
60 |
| -#language = None |
| 60 | +# language = None |
61 | 61 |
|
62 | 62 | # There are two options for replacing |today|: either, you set today to some
|
63 | 63 | # non-false value, then it is used:
|
64 |
| -#today = '' |
| 64 | +# today = '' |
65 | 65 | # Else, today_fmt is used as the format for a strftime call.
|
66 |
| -#today_fmt = '%B %d, %Y' |
| 66 | +# today_fmt = '%B %d, %Y' |
67 | 67 |
|
68 | 68 | # List of patterns, relative to source directory, that match files and
|
69 | 69 | # directories to ignore when looking for source files.
|
70 |
| -exclude_patterns = ['_build'] |
| 70 | +exclude_patterns = ["_build"] |
71 | 71 |
|
72 | 72 | # The reST default role (used for this markup: `text`) to use for all documents.
|
73 |
| -#default_role = None |
| 73 | +# default_role = None |
74 | 74 |
|
75 | 75 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
76 |
| -#add_function_parentheses = True |
| 76 | +# add_function_parentheses = True |
77 | 77 |
|
78 | 78 | # If true, the current module name will be prepended to all description
|
79 | 79 | # unit titles (such as .. function::).
|
80 |
| -#add_module_names = True |
| 80 | +# add_module_names = True |
81 | 81 |
|
82 | 82 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
83 | 83 | # output. They are ignored by default.
|
84 |
| -#show_authors = False |
| 84 | +# show_authors = False |
85 | 85 |
|
86 | 86 | # The name of the Pygments (syntax highlighting) style to use.
|
87 |
| -pygments_style = 'sphinx' |
| 87 | +pygments_style = "sphinx" |
88 | 88 |
|
89 | 89 | # A list of ignored prefixes for module index sorting.
|
90 |
| -#modindex_common_prefix = [] |
| 90 | +# modindex_common_prefix = [] |
91 | 91 |
|
92 | 92 |
|
93 | 93 | # -- Options for HTML output ---------------------------------------------------
|
|
99 | 99 | # Theme options are theme-specific and customize the look and feel of a theme
|
100 | 100 | # further. For a list of options available for each theme, see the
|
101 | 101 | # documentation.
|
102 |
| -#html_theme_options = {} |
| 102 | +# html_theme_options = {} |
103 | 103 |
|
104 | 104 | # Add any paths that contain custom themes here, relative to this directory.
|
105 |
| -#html_theme_path = [] |
| 105 | +# html_theme_path = [] |
106 | 106 |
|
107 | 107 | # The name for this set of Sphinx documents. If None, it defaults to
|
108 | 108 | # "<project> v<release> documentation".
|
109 |
| -#html_title = None |
| 109 | +# html_title = None |
110 | 110 |
|
111 | 111 | # A shorter title for the navigation bar. Default is the same as html_title.
|
112 |
| -#html_short_title = None |
| 112 | +# html_short_title = None |
113 | 113 |
|
114 | 114 | # The name of an image file (relative to this directory) to place at the top
|
115 | 115 | # of the sidebar.
|
116 |
| -#html_logo = None |
| 116 | +# html_logo = None |
117 | 117 |
|
118 | 118 | # The name of an image file (within the static path) to use as favicon of the
|
119 | 119 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
120 | 120 | # pixels large.
|
121 |
| -#html_favicon = None |
| 121 | +# html_favicon = None |
122 | 122 |
|
123 | 123 | # Add any paths that contain custom static files (such as style sheets) here,
|
124 | 124 | # relative to this directory. They are copied after the builtin static files,
|
125 | 125 | # so a file named "default.css" will overwrite the builtin "default.css".
|
126 |
| -html_static_path = ['_static'] |
| 126 | +html_static_path = ["_static"] |
127 | 127 |
|
128 | 128 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
129 | 129 | # using the given strftime format.
|
130 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 130 | +# html_last_updated_fmt = '%b %d, %Y' |
131 | 131 |
|
132 | 132 | # If true, SmartyPants will be used to convert quotes and dashes to
|
133 | 133 | # typographically correct entities.
|
134 |
| -#html_use_smartypants = True |
| 134 | +# html_use_smartypants = True |
135 | 135 |
|
136 | 136 | # Custom sidebar templates, maps document names to template names.
|
137 |
| -#html_sidebars = {} |
| 137 | +# html_sidebars = {} |
138 | 138 |
|
139 | 139 | # Additional templates that should be rendered to pages, maps page names to
|
140 | 140 | # template names.
|
141 |
| -#html_additional_pages = {} |
| 141 | +# html_additional_pages = {} |
142 | 142 |
|
143 | 143 | # If false, no module index is generated.
|
144 |
| -#html_domain_indices = True |
| 144 | +# html_domain_indices = True |
145 | 145 |
|
146 | 146 | # If false, no index is generated.
|
147 |
| -#html_use_index = True |
| 147 | +# html_use_index = True |
148 | 148 |
|
149 | 149 | # If true, the index is split into individual pages for each letter.
|
150 |
| -#html_split_index = False |
| 150 | +# html_split_index = False |
151 | 151 |
|
152 | 152 | # If true, links to the reST sources are added to the pages.
|
153 |
| -#html_show_sourcelink = True |
| 153 | +# html_show_sourcelink = True |
154 | 154 |
|
155 | 155 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
156 |
| -#html_show_sphinx = True |
| 156 | +# html_show_sphinx = True |
157 | 157 |
|
158 | 158 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
159 |
| -#html_show_copyright = True |
| 159 | +# html_show_copyright = True |
160 | 160 |
|
161 | 161 | # If true, an OpenSearch description file will be output, and all pages will
|
162 | 162 | # contain a <link> tag referring to it. The value of this option must be the
|
163 | 163 | # base URL from which the finished HTML is served.
|
164 |
| -#html_use_opensearch = '' |
| 164 | +# html_use_opensearch = '' |
165 | 165 |
|
166 | 166 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
167 |
| -#html_file_suffix = None |
| 167 | +# html_file_suffix = None |
168 | 168 |
|
169 | 169 | # Output file base name for HTML help builder.
|
170 |
| -htmlhelp_basename = 'django-robotsdoc' |
| 170 | +htmlhelp_basename = "django-robotsdoc" |
171 | 171 |
|
172 | 172 |
|
173 | 173 | # -- Options for LaTeX output --------------------------------------------------
|
174 | 174 |
|
175 | 175 | latex_elements = {
|
176 |
| -# The paper size ('letterpaper' or 'a4paper'). |
177 |
| -#'papersize': 'letterpaper', |
178 |
| - |
179 |
| -# The font size ('10pt', '11pt' or '12pt'). |
180 |
| -#'pointsize': '10pt', |
181 |
| - |
182 |
| -# Additional stuff for the LaTeX preamble. |
183 |
| -#'preamble': '', |
| 176 | + # The paper size ('letterpaper' or 'a4paper'). |
| 177 | + #'papersize': 'letterpaper', |
| 178 | + # The font size ('10pt', '11pt' or '12pt'). |
| 179 | + #'pointsize': '10pt', |
| 180 | + # Additional stuff for the LaTeX preamble. |
| 181 | + #'preamble': '', |
184 | 182 | }
|
185 | 183 |
|
186 | 184 | # Grouping the document tree into LaTeX files. List of tuples
|
187 | 185 | # (source start file, target name, title, author, documentclass [howto/manual]).
|
188 | 186 | latex_documents = [
|
189 |
| - ('index', 'django-robots.tex', u'django-robots Documentation', |
190 |
| - u'Jannis Leidel', 'manual'), |
| 187 | + ( |
| 188 | + "index", |
| 189 | + "django-robots.tex", |
| 190 | + u"django-robots Documentation", |
| 191 | + u"Jannis Leidel", |
| 192 | + "manual", |
| 193 | + ), |
191 | 194 | ]
|
192 | 195 |
|
193 | 196 | # The name of an image file (relative to this directory) to place at the top of
|
194 | 197 | # the title page.
|
195 |
| -#latex_logo = None |
| 198 | +# latex_logo = None |
196 | 199 |
|
197 | 200 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
198 | 201 | # not chapters.
|
199 |
| -#latex_use_parts = False |
| 202 | +# latex_use_parts = False |
200 | 203 |
|
201 | 204 | # If true, show page references after internal links.
|
202 |
| -#latex_show_pagerefs = False |
| 205 | +# latex_show_pagerefs = False |
203 | 206 |
|
204 | 207 | # If true, show URL addresses after external links.
|
205 |
| -#latex_show_urls = False |
| 208 | +# latex_show_urls = False |
206 | 209 |
|
207 | 210 | # Documents to append as an appendix to all manuals.
|
208 |
| -#latex_appendices = [] |
| 211 | +# latex_appendices = [] |
209 | 212 |
|
210 | 213 | # If false, no module index is generated.
|
211 |
| -#latex_domain_indices = True |
| 214 | +# latex_domain_indices = True |
212 | 215 |
|
213 | 216 |
|
214 | 217 | # -- Options for manual page output --------------------------------------------
|
215 | 218 |
|
216 | 219 | # One entry per manual page. List of tuples
|
217 | 220 | # (source start file, name, description, authors, manual section).
|
218 | 221 | man_pages = [
|
219 |
| - ('index', 'django-robots', u'django-robots Documentation', |
220 |
| - [u'Jannis Leidel'], 1) |
| 222 | + ("index", "django-robots", u"django-robots Documentation", [u"Jannis Leidel"], 1) |
221 | 223 | ]
|
222 | 224 |
|
223 | 225 | # If true, show URL addresses after external links.
|
224 |
| -#man_show_urls = False |
| 226 | +# man_show_urls = False |
225 | 227 |
|
226 | 228 |
|
227 | 229 | # -- Options for Texinfo output ------------------------------------------------
|
|
230 | 232 | # (source start file, target name, title, author,
|
231 | 233 | # dir menu entry, description, category)
|
232 | 234 | texinfo_documents = [
|
233 |
| - ('index', 'django-robots', u'django-robots Documentation', |
234 |
| - u'Jannis Leidel', 'django-robots', 'One line description of project.', |
235 |
| - 'Miscellaneous'), |
| 235 | + ( |
| 236 | + "index", |
| 237 | + "django-robots", |
| 238 | + u"django-robots Documentation", |
| 239 | + u"Jannis Leidel", |
| 240 | + "django-robots", |
| 241 | + "One line description of project.", |
| 242 | + "Miscellaneous", |
| 243 | + ), |
236 | 244 | ]
|
237 | 245 |
|
238 | 246 | # Documents to append as an appendix to all manuals.
|
239 |
| -#texinfo_appendices = [] |
| 247 | +# texinfo_appendices = [] |
240 | 248 |
|
241 | 249 | # If false, no module index is generated.
|
242 |
| -#texinfo_domain_indices = True |
| 250 | +# texinfo_domain_indices = True |
243 | 251 |
|
244 | 252 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
245 |
| -#texinfo_show_urls = 'footnote' |
| 253 | +# texinfo_show_urls = 'footnote' |
0 commit comments