|
16 | 16 | # If extensions (or modules to document with autodoc) are in another directory, |
17 | 17 | # add these directories to sys.path here. If the directory is relative to the |
18 | 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
19 | | -#sys.path.insert(0, os.path.abspath('.')) |
| 19 | +# sys.path.insert(0, os.path.abspath('.')) |
20 | 20 |
|
21 | 21 | # -- General configuration ----------------------------------------------------- |
22 | 22 |
|
23 | 23 | # If your documentation needs a minimal Sphinx version, state it here. |
24 | | -#needs_sphinx = '1.0' |
| 24 | +# needs_sphinx = '1.0' |
25 | 25 |
|
26 | 26 | # Add any Sphinx extension module names here, as strings. They can be extensions |
27 | 27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
28 | | -extensions = ['sphinx.ext.todo', 'sphinx.ext.imgmath', 'sphinx.ext.viewcode'] |
| 28 | +extensions = ["sphinx.ext.todo", "sphinx.ext.imgmath", "sphinx.ext.viewcode"] |
29 | 29 |
|
30 | 30 | # Add any paths that contain templates here, relative to this directory. |
31 | | -templates_path = ['_templates'] |
| 31 | +templates_path = ["_templates"] |
32 | 32 |
|
33 | 33 | # The suffix of source filenames. |
34 | | -source_suffix = '.rst' |
| 34 | +source_suffix = ".rst" |
35 | 35 |
|
36 | 36 | # The encoding of source files. |
37 | | -#source_encoding = 'utf-8-sig' |
| 37 | +# source_encoding = 'utf-8-sig' |
38 | 38 |
|
39 | 39 | # The master toctree document. |
40 | | -master_doc = 'index' |
| 40 | +master_doc = "index" |
41 | 41 |
|
42 | 42 | # General information about the project. |
43 | | -project = u'PluginExporter' |
44 | | -copyright = u'2013, Francis Lapointe' |
| 43 | +project = "PluginExporter" |
| 44 | +copyright = "2013, Francis Lapointe" |
45 | 45 |
|
46 | 46 | # The version info for the project you're documenting, acts as replacement for |
47 | 47 | # |version| and |release|, also used in various other places throughout the |
48 | 48 | # built documents. |
49 | 49 | # |
50 | 50 | # The short X.Y version. |
51 | | -version = '0.1' |
| 51 | +version = "0.1" |
52 | 52 | # The full version, including alpha/beta/rc tags. |
53 | | -release = '0.1' |
| 53 | +release = "0.1" |
54 | 54 |
|
55 | 55 | # The language for content autogenerated by Sphinx. Refer to documentation |
56 | 56 | # for a list of supported languages. |
57 | | -#language = None |
| 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 | 67 | exclude_patterns = [] |
68 | 68 |
|
69 | 69 | # The reST default role (used for this markup: `text`) to use for all documents. |
70 | | -#default_role = None |
| 70 | +# default_role = None |
71 | 71 |
|
72 | 72 | # If true, '()' will be appended to :func: etc. cross-reference text. |
73 | | -#add_function_parentheses = True |
| 73 | +# add_function_parentheses = True |
74 | 74 |
|
75 | 75 | # If true, the current module name will be prepended to all description |
76 | 76 | # unit titles (such as .. function::). |
77 | | -#add_TemplateModuleNames = True |
| 77 | +# add_TemplateModuleNames = True |
78 | 78 |
|
79 | 79 | # If true, sectionauthor and moduleauthor directives will be shown in the |
80 | 80 | # output. They are ignored by default. |
81 | | -#show_authors = False |
| 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 | | -#modindex_common_prefix = [] |
| 87 | +# modindex_common_prefix = [] |
88 | 88 |
|
89 | 89 |
|
90 | 90 | # -- Options for HTML output --------------------------------------------------- |
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 = 'default' |
| 94 | +html_theme = "default" |
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 | | -#html_theme_options = {} |
| 99 | +# html_theme_options = {} |
100 | 100 |
|
101 | 101 | # Add any paths that contain custom themes here, relative to this directory. |
102 | | -#html_theme_path = [] |
| 102 | +# html_theme_path = [] |
103 | 103 |
|
104 | 104 | # The name for this set of Sphinx documents. If None, it defaults to |
105 | 105 | # "<project> v<release> documentation". |
106 | | -#html_title = None |
| 106 | +# html_title = None |
107 | 107 |
|
108 | 108 | # A shorter title for the navigation bar. Default is the same as html_title. |
109 | | -#html_short_title = None |
| 109 | +# html_short_title = None |
110 | 110 |
|
111 | 111 | # The name of an image file (relative to this directory) to place at the top |
112 | 112 | # of the sidebar. |
113 | | -#html_logo = None |
| 113 | +# html_logo = None |
114 | 114 |
|
115 | 115 | # The name of an image file (within the static path) to use as favicon of the |
116 | 116 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
117 | 117 | # pixels large. |
118 | | -#html_favicon = None |
| 118 | +# html_favicon = None |
119 | 119 |
|
120 | 120 | # Add any paths that contain custom static files (such as style sheets) here, |
121 | 121 | # relative to this directory. They are copied after the builtin static files, |
122 | 122 | # so a file named "default.css" will overwrite the builtin "default.css". |
123 | | -html_static_path = ['_static'] |
| 123 | +html_static_path = ["_static"] |
124 | 124 |
|
125 | 125 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
126 | 126 | # using the given strftime format. |
127 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 127 | +# html_last_updated_fmt = '%b %d, %Y' |
128 | 128 |
|
129 | 129 | # If true, SmartyPants will be used to convert quotes and dashes to |
130 | 130 | # typographically correct entities. |
131 | | -#html_use_smartypants = True |
| 131 | +# html_use_smartypants = True |
132 | 132 |
|
133 | 133 | # Custom sidebar templates, maps document names to template names. |
134 | | -#html_sidebars = {} |
| 134 | +# html_sidebars = {} |
135 | 135 |
|
136 | 136 | # Additional templates that should be rendered to pages, maps page names to |
137 | 137 | # template names. |
138 | | -#html_additional_pages = {} |
| 138 | +# html_additional_pages = {} |
139 | 139 |
|
140 | 140 | # If false, no module index is generated. |
141 | | -#html_domain_indices = True |
| 141 | +# html_domain_indices = True |
142 | 142 |
|
143 | 143 | # If false, no index is generated. |
144 | | -#html_use_index = True |
| 144 | +# html_use_index = True |
145 | 145 |
|
146 | 146 | # If true, the index is split into individual pages for each letter. |
147 | | -#html_split_index = False |
| 147 | +# html_split_index = False |
148 | 148 |
|
149 | 149 | # If true, links to the reST sources are added to the pages. |
150 | | -#html_show_sourcelink = True |
| 150 | +# html_show_sourcelink = True |
151 | 151 |
|
152 | 152 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
153 | | -#html_show_sphinx = True |
| 153 | +# html_show_sphinx = True |
154 | 154 |
|
155 | 155 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
156 | | -#html_show_copyright = True |
| 156 | +# html_show_copyright = True |
157 | 157 |
|
158 | 158 | # If true, an OpenSearch description file will be output, and all pages will |
159 | 159 | # contain a <link> tag referring to it. The value of this option must be the |
160 | 160 | # base URL from which the finished HTML is served. |
161 | | -#html_use_opensearch = '' |
| 161 | +# html_use_opensearch = '' |
162 | 162 |
|
163 | 163 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
164 | | -#html_file_suffix = None |
| 164 | +# html_file_suffix = None |
165 | 165 |
|
166 | 166 | # Output file base name for HTML help builder. |
167 | | -htmlhelp_basename = 'TemplateClassdoc' |
| 167 | +htmlhelp_basename = "TemplateClassdoc" |
168 | 168 |
|
169 | 169 |
|
170 | 170 | # -- Options for LaTeX output -------------------------------------------------- |
171 | 171 |
|
172 | 172 | # The paper size ('letter' or 'a4'). |
173 | | -#latex_paper_size = 'letter' |
| 173 | +# latex_paper_size = 'letter' |
174 | 174 |
|
175 | 175 | # The font size ('10pt', '11pt' or '12pt'). |
176 | | -#latex_font_size = '10pt' |
| 176 | +# latex_font_size = '10pt' |
177 | 177 |
|
178 | 178 | # Grouping the document tree into LaTeX files. List of tuples |
179 | 179 | # (source start file, target name, title, author, documentclass [howto/manual]). |
180 | 180 | latex_documents = [ |
181 | | - ('index', 'PluginExporter.tex', u'PluginExporter Documentation', |
182 | | - u'Francis Lapointe', 'manual'), |
| 181 | + ( |
| 182 | + "index", |
| 183 | + "PluginExporter.tex", |
| 184 | + "PluginExporter Documentation", |
| 185 | + "Francis Lapointe", |
| 186 | + "manual", |
| 187 | + ), |
183 | 188 | ] |
184 | 189 |
|
185 | 190 | # The name of an image file (relative to this directory) to place at the top of |
186 | 191 | # the title page. |
187 | | -#latex_logo = None |
| 192 | +# latex_logo = None |
188 | 193 |
|
189 | 194 | # For "manual" documents, if this is true, then toplevel headings are parts, |
190 | 195 | # not chapters. |
191 | | -#latex_use_parts = False |
| 196 | +# latex_use_parts = False |
192 | 197 |
|
193 | 198 | # If true, show page references after internal links. |
194 | | -#latex_show_pagerefs = False |
| 199 | +# latex_show_pagerefs = False |
195 | 200 |
|
196 | 201 | # If true, show URL addresses after external links. |
197 | | -#latex_show_urls = False |
| 202 | +# latex_show_urls = False |
198 | 203 |
|
199 | 204 | # Additional stuff for the LaTeX preamble. |
200 | | -#latex_preamble = '' |
| 205 | +# latex_preamble = '' |
201 | 206 |
|
202 | 207 | # Documents to append as an appendix to all manuals. |
203 | | -#latex_appendices = [] |
| 208 | +# latex_appendices = [] |
204 | 209 |
|
205 | 210 | # If false, no module index is generated. |
206 | | -#latex_domain_indices = True |
| 211 | +# latex_domain_indices = True |
207 | 212 |
|
208 | 213 |
|
209 | 214 | # -- Options for manual page output -------------------------------------------- |
210 | 215 |
|
211 | 216 | # One entry per manual page. List of tuples |
212 | 217 | # (source start file, name, description, authors, manual section). |
213 | 218 | man_pages = [ |
214 | | - ('index', 'TemplateClass', u'PluginExporter Documentation', |
215 | | - [u'Francis Lapointe'], 1) |
| 219 | + ("index", "TemplateClass", "PluginExporter Documentation", ["Francis Lapointe"], 1) |
216 | 220 | ] |
0 commit comments