|
12 | 12 | # serve to show the default. |
13 | 13 |
|
14 | 14 | import sys, os |
15 | | -sys.path.insert(0, os.path.abspath('..')) |
| 15 | +sys.path.insert(0, os.path.abspath("..")) |
16 | 16 |
|
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('.')) |
| 20 | +#sys.path.insert(0, os.path.abspath(".")) |
21 | 21 |
|
22 | 22 | # -- General configuration ----------------------------------------------------- |
23 | 23 |
|
24 | 24 | # If your documentation needs a minimal Sphinx version, state it here. |
25 | | -#needs_sphinx = '1.0' |
| 25 | +#needs_sphinx = "1.0" |
26 | 26 |
|
27 | 27 | # Add any Sphinx extension module names here, as strings. They can be extensions |
28 | | -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
29 | | -extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.autodoc'] |
| 28 | +# coming with Sphinx (named "sphinx.ext.*") or your custom ones. |
| 29 | +extensions = ["sphinx.ext.intersphinx", "sphinx.ext.autodoc"] |
30 | 30 |
|
31 | 31 | # Add any paths that contain templates here, relative to this directory. |
32 | | -templates_path = ['_templates'] |
| 32 | +templates_path = ["_templates"] |
33 | 33 |
|
34 | 34 | # The suffix of source filenames. |
35 | | -source_suffix = '.rst' |
| 35 | +source_suffix = ".rst" |
36 | 36 |
|
37 | 37 | # The encoding of source files. |
38 | | -#source_encoding = 'utf-8-sig' |
| 38 | +#source_encoding = "utf-8-sig" |
39 | 39 |
|
40 | 40 | # The master toctree document. |
41 | | -master_doc = 'index' |
| 41 | +master_doc = "index" |
42 | 42 |
|
43 | 43 | # General information about the project. |
44 | | -project = u'Flask-PyMongo' |
45 | | -copyright = u'2011 - 2017, Dan Crosta' |
| 44 | +project = u"Flask-PyMongo" |
| 45 | +copyright = u"2011 - 2017, Dan Crosta" |
46 | 46 |
|
47 | | -# The version info for the project you're documenting, acts as replacement for |
| 47 | +# The version info for the project you"re documenting, acts as replacement for |
48 | 48 | # |version| and |release|, also used in various other places throughout the |
49 | 49 | # built documents. |
50 | 50 | # |
51 | | -version = '0.5.2' |
| 51 | +version = "0.5.2" |
52 | 52 | # The full version, including alpha/beta/rc tags. |
53 | | -release = '0.5.2' |
| 53 | +release = "0.5.2" |
54 | 54 |
|
55 | 55 | # The language for content autogenerated by Sphinx. Refer to documentation |
56 | 56 | # for a list of supported languages. |
57 | 57 | #language = None |
58 | 58 |
|
59 | 59 | # There are two options for replacing |today|: either, you set today to some |
60 | 60 | # non-false value, then it is used: |
61 | | -#today = '' |
| 61 | +#today = "" |
62 | 62 | # Else, today_fmt is used as the format for a strftime call. |
63 | | -#today_fmt = '%B %d, %Y' |
| 63 | +#today_fmt = "%B %d, %Y" |
64 | 64 |
|
65 | 65 | # List of patterns, relative to source directory, that match files and |
66 | 66 | # directories to ignore when looking for source files. |
67 | | -exclude_patterns = ['_build'] |
| 67 | +exclude_patterns = ["_build"] |
68 | 68 |
|
69 | 69 | # The reST default role (used for this markup: `text`) to use for all documents. |
70 | 70 | #default_role = None |
71 | 71 |
|
72 | | -# If true, '()' will be appended to :func: etc. cross-reference text. |
| 72 | +# If true, "()" will be appended to :func: etc. cross-reference text. |
73 | 73 | #add_function_parentheses = True |
74 | 74 |
|
75 | 75 | # If true, the current module name will be prepended to all description |
|
81 | 81 | #show_authors = False |
82 | 82 |
|
83 | 83 | # The name of the Pygments (syntax highlighting) style to use. |
84 | | -pygments_style = 'sphinx' |
| 84 | +pygments_style = "sphinx" |
85 | 85 |
|
86 | 86 | # A list of ignored prefixes for module index sorting. |
87 | 87 | #modindex_common_prefix = [] |
|
91 | 91 |
|
92 | 92 | # The theme to use for HTML and HTML Help pages. See the documentation for |
93 | 93 | # a list of builtin themes. |
94 | | -html_theme = 'flask_small' |
| 94 | +html_theme = "flask_small" |
95 | 95 |
|
96 | 96 | # Theme options are theme-specific and customize the look and feel of a theme |
97 | 97 | # further. For a list of options available for each theme, see the |
98 | 98 | # documentation. |
99 | 99 | #html_theme_options = {} |
100 | 100 |
|
101 | 101 | # Add any paths that contain custom themes here, relative to this directory. |
102 | | -sys.path.append(os.path.abspath('_themes')) |
103 | | -html_theme_path = ['_themes'] |
| 102 | +sys.path.append(os.path.abspath("_themes")) |
| 103 | +html_theme_path = ["_themes"] |
104 | 104 |
|
105 | 105 | # custom settings for flask theme |
106 | 106 | html_theme_options = { |
107 | | - 'index_logo': '', #TODO |
108 | | - 'github_fork': 'dcrosta/flask-pymongo', |
| 107 | + "index_logo": "", #TODO |
| 108 | + "github_fork": "dcrosta/flask-pymongo", |
109 | 109 | } |
110 | 110 |
|
111 | 111 | # The name for this set of Sphinx documents. If None, it defaults to |
|
127 | 127 | # Add any paths that contain custom static files (such as style sheets) here, |
128 | 128 | # relative to this directory. They are copied after the builtin static files, |
129 | 129 | # so a file named "default.css" will overwrite the builtin "default.css". |
130 | | -html_static_path = ['_static'] |
| 130 | +html_static_path = ["_static"] |
131 | 131 |
|
132 | | -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| 132 | +# If not "", a "Last updated on:" timestamp is inserted at every page bottom, |
133 | 133 | # using the given strftime format. |
134 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 134 | +#html_last_updated_fmt = "%b %d, %Y" |
135 | 135 |
|
136 | 136 | # If true, SmartyPants will be used to convert quotes and dashes to |
137 | 137 | # typographically correct entities. |
|
165 | 165 | # If true, an OpenSearch description file will be output, and all pages will |
166 | 166 | # contain a <link> tag referring to it. The value of this option must be the |
167 | 167 | # base URL from which the finished HTML is served. |
168 | | -#html_use_opensearch = '' |
| 168 | +#html_use_opensearch = "" |
169 | 169 |
|
170 | 170 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
171 | 171 | #html_file_suffix = None |
172 | 172 |
|
173 | 173 | # Output file base name for HTML help builder. |
174 | | -htmlhelp_basename = 'Flask-PyMongodoc' |
| 174 | +htmlhelp_basename = "Flask-PyMongodoc" |
175 | 175 |
|
176 | 176 |
|
177 | 177 | # -- Options for LaTeX output -------------------------------------------------- |
178 | 178 |
|
179 | 179 | latex_elements = { |
180 | | -# The paper size ('letterpaper' or 'a4paper'). |
181 | | -#'papersize': 'letterpaper', |
| 180 | +# The paper size ("letterpaper" or "a4paper"). |
| 181 | +#"papersize": "letterpaper", |
182 | 182 |
|
183 | | -# The font size ('10pt', '11pt' or '12pt'). |
184 | | -#'pointsize': '10pt', |
| 183 | +# The font size ("10pt", "11pt" or "12pt"). |
| 184 | +#"pointsize": "10pt", |
185 | 185 |
|
186 | 186 | # Additional stuff for the LaTeX preamble. |
187 | | -#'preamble': '', |
| 187 | +#"preamble": "", |
188 | 188 | } |
189 | 189 |
|
190 | 190 | # Grouping the document tree into LaTeX files. List of tuples |
191 | 191 | # (source start file, target name, title, author, documentclass [howto/manual]). |
192 | 192 | latex_documents = [ |
193 | | - ('index', 'Flask-PyMongo.tex', u'Flask-PyMongo Documentation', |
194 | | - u'Dan Crosta', 'manual'), |
| 193 | + ("index", "Flask-PyMongo.tex", u"Flask-PyMongo Documentation", |
| 194 | + u"Dan Crosta", "manual"), |
195 | 195 | ] |
196 | 196 |
|
197 | 197 | # The name of an image file (relative to this directory) to place at the top of |
|
220 | 220 | # One entry per manual page. List of tuples |
221 | 221 | # (source start file, name, description, authors, manual section). |
222 | 222 | man_pages = [ |
223 | | - ('index', 'flask-pymongo', u'Flask-PyMongo Documentation', |
224 | | - [u'Dan Crosta'], 1) |
| 223 | + ("index", "flask-pymongo", u"Flask-PyMongo Documentation", |
| 224 | + [u"Dan Crosta"], 1) |
225 | 225 | ] |
226 | 226 |
|
227 | 227 | # If true, show URL addresses after external links. |
|
234 | 234 | # (source start file, target name, title, author, |
235 | 235 | # dir menu entry, description, category) |
236 | 236 | texinfo_documents = [ |
237 | | - ('index', 'Flask-PyMongo', u'Flask-PyMongo Documentation', |
238 | | - u'Dan Crosta', 'Flask-PyMongo', 'One line description of project.', |
239 | | - 'Miscellaneous'), |
| 237 | + ("index", "Flask-PyMongo", u"Flask-PyMongo Documentation", |
| 238 | + u"Dan Crosta", "Flask-PyMongo", "One line description of project.", |
| 239 | + "Miscellaneous"), |
240 | 240 | ] |
241 | 241 |
|
242 | 242 | # Documents to append as an appendix to all manuals. |
|
245 | 245 | # If false, no module index is generated. |
246 | 246 | #texinfo_domain_indices = True |
247 | 247 |
|
248 | | -# How to display URL addresses: 'footnote', 'no', or 'inline'. |
249 | | -#texinfo_show_urls = 'footnote' |
| 248 | +# How to display URL addresses: "footnote", "no", or "inline". |
| 249 | +#texinfo_show_urls = "footnote" |
250 | 250 |
|
251 | 251 |
|
252 | 252 | # Example configuration for intersphinx: refer to the Python standard library. |
253 | 253 | intersphinx_mapping = { |
254 | | - 'python': ('http://docs.python.org/', None), |
255 | | - 'flask': ('http://flask.pocoo.org/docs/', None), |
256 | | - 'pymongo': ('http://api.mongodb.org/python/current/', None), |
| 254 | + "python": ("http://docs.python.org/", None), |
| 255 | + "flask": ("http://flask.pocoo.org/docs/", None), |
| 256 | + "pymongo": ("http://api.mongodb.org/python/current/", None), |
257 | 257 | } |
0 commit comments