|
26 | 26 | # -- General configuration ------------------------------------------------ |
27 | 27 |
|
28 | 28 | # If your documentation needs a minimal Sphinx version, state it here. |
29 | | -#needs_sphinx = '1.0' |
| 29 | +# needs_sphinx = '1.0' |
30 | 30 |
|
31 | 31 | # Add any Sphinx extension module names here, as strings. They can be |
32 | 32 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
47 | 47 | # pngmath / imgmath compatibility layer for different sphinx versions |
48 | 48 | import sphinx |
49 | 49 | from distutils.version import LooseVersion |
| 50 | + |
50 | 51 | if LooseVersion(sphinx.__version__) < LooseVersion('1.4'): |
51 | 52 | extensions.append('sphinx.ext.pngmath') |
52 | 53 | else: |
|
64 | 65 | source_suffix = '.rst' |
65 | 66 |
|
66 | 67 | # The encoding of source files. |
67 | | -#source_encoding = 'utf-8-sig' |
| 68 | +# source_encoding = 'utf-8-sig' |
68 | 69 |
|
69 | 70 | # Generate the plots for the gallery |
70 | 71 | plot_gallery = True |
|
82 | 83 | # |
83 | 84 | # The short X.Y version. |
84 | 85 | from cmdstanpy import __version__ |
| 86 | + |
85 | 87 | version = __version__ |
86 | 88 | # The full version, including alpha/beta/rc tags. |
87 | 89 | release = __version__ |
88 | 90 |
|
89 | 91 | # The language for content autogenerated by Sphinx. Refer to documentation |
90 | 92 | # for a list of supported languages. |
91 | | -#language = None |
| 93 | +# language = None |
92 | 94 |
|
93 | 95 | # There are two options for replacing |today|: either, you set today to some |
94 | 96 | # non-false value, then it is used: |
95 | | -#today = '' |
| 97 | +# today = '' |
96 | 98 | # Else, today_fmt is used as the format for a strftime call. |
97 | | -#today_fmt = '%B %d, %Y' |
| 99 | +# today_fmt = '%B %d, %Y' |
98 | 100 |
|
99 | 101 | # List of patterns, relative to source directory, that match files and |
100 | 102 | # directories to ignore when looking for source files. |
101 | 103 | exclude_patterns = ['_build', '_templates'] |
102 | 104 |
|
103 | 105 | # The reST default role (used for this markup: `text`) to use for all |
104 | 106 | # documents. |
105 | | -#default_role = None |
| 107 | +# default_role = None |
106 | 108 |
|
107 | 109 | # If true, '()' will be appended to :func: etc. cross-reference text. |
108 | | -#add_function_parentheses = True |
| 110 | +# add_function_parentheses = True |
109 | 111 |
|
110 | 112 | # If true, the current module name will be prepended to all description |
111 | 113 | # unit titles (such as .. function::). |
112 | | -#add_module_names = True |
| 114 | +# add_module_names = True |
113 | 115 |
|
114 | 116 | # If true, sectionauthor and moduleauthor directives will be shown in the |
115 | 117 | # output. They are ignored by default. |
116 | | -#show_authors = False |
| 118 | +# show_authors = False |
117 | 119 |
|
118 | 120 | # The name of the Pygments (syntax highlighting) style to use. |
119 | 121 | pygments_style = 'sphinx' |
|
122 | 124 | html_style = 'css/project-template.css' |
123 | 125 |
|
124 | 126 | # A list of ignored prefixes for module index sorting. |
125 | | -#modindex_common_prefix = [] |
| 127 | +# modindex_common_prefix = [] |
126 | 128 |
|
127 | 129 | # If true, keep warnings as "system message" paragraphs in the built documents. |
128 | | -#keep_warnings = False |
| 130 | +# keep_warnings = False |
129 | 131 |
|
130 | 132 |
|
131 | 133 | # -- Options for HTML output ---------------------------------------------- |
|
137 | 139 | # Theme options are theme-specific and customize the look and feel of a theme |
138 | 140 | # further. For a list of options available for each theme, see the |
139 | 141 | # documentation. |
140 | | -#html_theme_options = {} |
| 142 | +# html_theme_options = {} |
141 | 143 |
|
142 | 144 | # Add any paths that contain custom themes here, relative to this directory. |
143 | 145 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
144 | 146 |
|
145 | 147 | # The name for this set of Sphinx documents. If None, it defaults to |
146 | 148 | # "<project> v<release> documentation". |
147 | | -#html_title = None |
| 149 | +# html_title = None |
148 | 150 |
|
149 | 151 | # A shorter title for the navigation bar. Default is the same as html_title. |
150 | | -#html_short_title = None |
| 152 | +# html_short_title = None |
151 | 153 |
|
152 | 154 | # The name of an image file (relative to this directory) to place at the top |
153 | 155 | # of the sidebar. |
154 | | -#html_logo = None |
| 156 | +# html_logo = None |
155 | 157 |
|
156 | 158 | # The name of an image file (within the static path) to use as favicon of the |
157 | 159 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
158 | 160 | # pixels large. |
159 | | -#html_favicon = None |
| 161 | +# html_favicon = None |
160 | 162 |
|
161 | 163 | # Add any paths that contain custom static files (such as style sheets) here, |
162 | 164 | # relative to this directory. They are copied after the builtin static files, |
|
166 | 168 | # Add any extra paths that contain custom files (such as robots.txt or |
167 | 169 | # .htaccess) here, relative to this directory. These files are copied |
168 | 170 | # directly to the root of the documentation. |
169 | | -#html_extra_path = [] |
| 171 | +# html_extra_path = [] |
170 | 172 |
|
171 | 173 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
172 | 174 | # using the given strftime format. |
173 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 175 | +# html_last_updated_fmt = '%b %d, %Y' |
174 | 176 |
|
175 | 177 | # If true, SmartyPants will be used to convert quotes and dashes to |
176 | 178 | # typographically correct entities. |
177 | | -#html_use_smartypants = True |
| 179 | +# html_use_smartypants = True |
178 | 180 |
|
179 | 181 | # Custom sidebar templates, maps document names to template names. |
180 | | -#html_sidebars = {} |
| 182 | +# html_sidebars = {} |
181 | 183 |
|
182 | 184 | # Additional templates that should be rendered to pages, maps page names to |
183 | 185 | # template names. |
184 | | -#html_additional_pages = {} |
| 186 | +# html_additional_pages = {} |
185 | 187 |
|
186 | 188 | # If false, no module index is generated. |
187 | | -#html_domain_indices = True |
| 189 | +# html_domain_indices = True |
188 | 190 |
|
189 | 191 | # If false, no index is generated. |
190 | | -#html_use_index = True |
| 192 | +# html_use_index = True |
191 | 193 |
|
192 | 194 | # If true, the index is split into individual pages for each letter. |
193 | | -#html_split_index = False |
| 195 | +# html_split_index = False |
194 | 196 |
|
195 | 197 | # If true, links to the reST sources are added to the pages. |
196 | | -#html_show_sourcelink = True |
| 198 | +# html_show_sourcelink = True |
197 | 199 |
|
198 | 200 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
199 | | -#html_show_sphinx = True |
| 201 | +# html_show_sphinx = True |
200 | 202 |
|
201 | 203 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
202 | | -#html_show_copyright = True |
| 204 | +# html_show_copyright = True |
203 | 205 |
|
204 | 206 | # If true, an OpenSearch description file will be output, and all pages will |
205 | 207 | # contain a <link> tag referring to it. The value of this option must be the |
206 | 208 | # base URL from which the finished HTML is served. |
207 | | -#html_use_opensearch = '' |
| 209 | +# html_use_opensearch = '' |
208 | 210 |
|
209 | 211 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
210 | | -#html_file_suffix = None |
| 212 | +# html_file_suffix = None |
211 | 213 |
|
212 | 214 | # Output file base name for HTML help builder. |
213 | 215 | htmlhelp_basename = 'project-templatedoc' |
|
216 | 218 | # -- Options for LaTeX output --------------------------------------------- |
217 | 219 |
|
218 | 220 | latex_elements = { |
219 | | -# The paper size ('letterpaper' or 'a4paper'). |
220 | | -#'papersize': 'letterpaper', |
221 | | - |
222 | | -# The font size ('10pt', '11pt' or '12pt'). |
223 | | -#'pointsize': '10pt', |
224 | | - |
225 | | -# Additional stuff for the LaTeX preamble. |
226 | | -#'preamble': '', |
| 221 | + # The paper size ('letterpaper' or 'a4paper'). |
| 222 | + #'papersize': 'letterpaper', |
| 223 | + # The font size ('10pt', '11pt' or '12pt'). |
| 224 | + #'pointsize': '10pt', |
| 225 | + # Additional stuff for the LaTeX preamble. |
| 226 | + #'preamble': '', |
227 | 227 | } |
228 | 228 |
|
229 | 229 | # Grouping the document tree into LaTeX files. List of tuples |
230 | 230 | # (source start file, target name, title, |
231 | 231 | # author, documentclass [howto, manual, or own class]). |
232 | 232 | latex_documents = [ |
233 | | - ('index', 'project-template.tex', u'project-template Documentation', |
234 | | - u'Stan Development Team', 'manual'), |
| 233 | + ( |
| 234 | + 'index', |
| 235 | + 'project-template.tex', |
| 236 | + u'project-template Documentation', |
| 237 | + u'Stan Development Team', |
| 238 | + 'manual', |
| 239 | + ), |
235 | 240 | ] |
236 | 241 |
|
237 | 242 | # The name of an image file (relative to this directory) to place at the top of |
238 | 243 | # the title page. |
239 | | -#latex_logo = None |
| 244 | +# latex_logo = None |
240 | 245 |
|
241 | 246 | # For "manual" documents, if this is true, then toplevel headings are parts, |
242 | 247 | # not chapters. |
243 | | -#latex_use_parts = False |
| 248 | +# latex_use_parts = False |
244 | 249 |
|
245 | 250 | # If true, show page references after internal links. |
246 | | -#latex_show_pagerefs = False |
| 251 | +# latex_show_pagerefs = False |
247 | 252 |
|
248 | 253 | # If true, show URL addresses after external links. |
249 | | -#latex_show_urls = False |
| 254 | +# latex_show_urls = False |
250 | 255 |
|
251 | 256 | # Documents to append as an appendix to all manuals. |
252 | | -#latex_appendices = [] |
| 257 | +# latex_appendices = [] |
253 | 258 |
|
254 | 259 | # If false, no module index is generated. |
255 | | -#latex_domain_indices = True |
| 260 | +# latex_domain_indices = True |
256 | 261 |
|
257 | 262 |
|
258 | 263 | # -- Options for manual page output --------------------------------------- |
259 | 264 |
|
260 | 265 | # One entry per manual page. List of tuples |
261 | 266 | # (source start file, name, description, authors, manual section). |
262 | 267 | man_pages = [ |
263 | | - ('index', 'project-template', u'project-template Documentation', |
264 | | - [u'Stan Development Team'], 1) |
| 268 | + ( |
| 269 | + 'index', |
| 270 | + 'project-template', |
| 271 | + u'project-template Documentation', |
| 272 | + [u'Stan Development Team'], |
| 273 | + 1, |
| 274 | + ) |
265 | 275 | ] |
266 | 276 |
|
267 | 277 | # If true, show URL addresses after external links. |
268 | | -#man_show_urls = False |
| 278 | +# man_show_urls = False |
269 | 279 |
|
270 | 280 |
|
271 | 281 | # -- Options for Texinfo output ------------------------------------------- |
|
274 | 284 | # (source start file, target name, title, author, |
275 | 285 | # dir menu entry, description, category) |
276 | 286 | texinfo_documents = [ |
277 | | - ('index', 'project-template', u'project-template Documentation', |
278 | | - u'Stan Development Team', 'project-template', '', ''), |
| 287 | + ( |
| 288 | + 'index', |
| 289 | + 'project-template', |
| 290 | + u'project-template Documentation', |
| 291 | + u'Stan Development Team', |
| 292 | + 'project-template', |
| 293 | + '', |
| 294 | + '', |
| 295 | + ), |
279 | 296 | ] |
280 | 297 |
|
281 | 298 | # Documents to append as an appendix to all manuals. |
282 | | -#texinfo_appendices = [] |
| 299 | +# texinfo_appendices = [] |
283 | 300 |
|
284 | 301 | # If false, no module index is generated. |
285 | | -#texinfo_domain_indices = True |
| 302 | +# texinfo_domain_indices = True |
286 | 303 |
|
287 | 304 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
288 | | -#texinfo_show_urls = 'footnote' |
| 305 | +# texinfo_show_urls = 'footnote' |
289 | 306 |
|
290 | 307 | # If true, do not generate a @detailmenu in the "Top" node's menu. |
291 | | -#texinfo_no_detailmenu = False |
| 308 | +# texinfo_no_detailmenu = False |
292 | 309 |
|
293 | 310 |
|
294 | 311 | # # Example configuration for intersphinx: refer to the Python standard library. |
|
301 | 318 | # 'matplotlib': ('https://matplotlib.org/', None), |
302 | 319 | # 'sklearn': ('http://scikit-learn.org/stable', None) |
303 | 320 | # } |
304 | | -# |
| 321 | +# |
305 | 322 | # # sphinx-gallery configuration |
306 | 323 | # sphinx_gallery_conf = { |
307 | 324 | # 'doc_module': 'skltemplate', |
|
310 | 327 | # 'skltemplate': None} |
311 | 328 | # } |
312 | 329 |
|
| 330 | + |
313 | 331 | def setup(app): |
314 | 332 | # a copy button to copy snippet of code from the documentation |
315 | 333 | app.add_javascript('js/copybutton.js') |
0 commit comments