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