|  | 
| 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('.')) | 
| 22 | 21 | sys.path.insert(0, abspath(pjoin('..', '..'))) | 
| 23 | 22 | 
 | 
| 24 | 23 | # -- General configuration ------------------------------------------------ | 
| 25 | 24 | 
 | 
| 26 | 25 | # If your documentation needs a minimal Sphinx version, state it here. | 
| 27 |  | -#needs_sphinx = '1.0' | 
|  | 26 | +# needs_sphinx = '1.0' | 
| 28 | 27 | 
 | 
| 29 | 28 | # Add any Sphinx extension module names here, as strings. They can be | 
| 30 | 29 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | 
|  | 
| 38 | 37 | source_suffix = '.rst' | 
| 39 | 38 | 
 | 
| 40 | 39 | # The encoding of source files. | 
| 41 |  | -#source_encoding = 'utf-8-sig' | 
|  | 40 | +# source_encoding = 'utf-8-sig' | 
| 42 | 41 | 
 | 
| 43 | 42 | # The master toctree document. | 
| 44 | 43 | master_doc = 'index' | 
|  | 
| 58 | 57 | 
 | 
| 59 | 58 | # The language for content autogenerated by Sphinx. Refer to documentation | 
| 60 | 59 | # for a list of supported languages. | 
| 61 |  | -#language = None | 
|  | 60 | +# language = None | 
| 62 | 61 | 
 | 
| 63 | 62 | # There are two options for replacing |today|: either, you set today to some | 
| 64 | 63 | # non-false value, then it is used: | 
| 65 |  | -#today = '' | 
|  | 64 | +# today = '' | 
| 66 | 65 | # Else, today_fmt is used as the format for a strftime call. | 
| 67 |  | -#today_fmt = '%B %d, %Y' | 
|  | 66 | +# today_fmt = '%B %d, %Y' | 
| 68 | 67 | 
 | 
| 69 | 68 | # List of patterns, relative to source directory, that match files and | 
| 70 | 69 | # directories to ignore when looking for source files. | 
| 71 | 70 | exclude_patterns = ['_build'] | 
| 72 | 71 | 
 | 
| 73 | 72 | # The reST default role (used for this markup: `text`) to use for all | 
| 74 | 73 | # documents. | 
| 75 |  | -#default_role = None | 
|  | 74 | +# default_role = None | 
| 76 | 75 | 
 | 
| 77 | 76 | # If true, '()' will be appended to :func: etc. cross-reference text. | 
| 78 |  | -#add_function_parentheses = True | 
|  | 77 | +# add_function_parentheses = True | 
| 79 | 78 | 
 | 
| 80 | 79 | # If true, the current module name will be prepended to all description | 
| 81 | 80 | # unit titles (such as .. function::). | 
| 82 |  | -#add_module_names = True | 
|  | 81 | +# add_module_names = True | 
| 83 | 82 | 
 | 
| 84 | 83 | # If true, sectionauthor and moduleauthor directives will be shown in the | 
| 85 | 84 | # output. They are ignored by default. | 
| 86 |  | -#show_authors = False | 
|  | 85 | +# show_authors = False | 
| 87 | 86 | 
 | 
| 88 | 87 | # The name of the Pygments (syntax highlighting) style to use. | 
| 89 | 88 | pygments_style = 'sphinx' | 
| 90 | 89 | 
 | 
| 91 | 90 | # A list of ignored prefixes for module index sorting. | 
| 92 |  | -#modindex_common_prefix = [] | 
|  | 91 | +# modindex_common_prefix = [] | 
| 93 | 92 | 
 | 
| 94 | 93 | # If true, keep warnings as "system message" paragraphs in the built documents. | 
| 95 |  | -#keep_warnings = False | 
|  | 94 | +# keep_warnings = False | 
| 96 | 95 | 
 | 
| 97 | 96 | 
 | 
| 98 | 97 | # -- Options for HTML output ---------------------------------------------- | 
|  | 
| 107 | 106 | # Theme options are theme-specific and customize the look and feel of a theme | 
| 108 | 107 | # further.  For a list of options available for each theme, see the | 
| 109 | 108 | # documentation. | 
| 110 |  | -#html_theme_options = {} | 
|  | 109 | +# html_theme_options = {} | 
| 111 | 110 | 
 | 
| 112 | 111 | # Add any paths that contain custom themes here, relative to this directory. | 
| 113 |  | -#html_theme_path = [] | 
|  | 112 | +# html_theme_path = [] | 
| 114 | 113 | 
 | 
| 115 | 114 | # The name for this set of Sphinx documents.  If None, it defaults to | 
| 116 | 115 | # "<project> v<release> documentation". | 
| 117 |  | -#html_title = None | 
|  | 116 | +# html_title = None | 
| 118 | 117 | 
 | 
| 119 | 118 | # A shorter title for the navigation bar.  Default is the same as html_title. | 
| 120 |  | -#html_short_title = None | 
|  | 119 | +# html_short_title = None | 
| 121 | 120 | 
 | 
| 122 | 121 | # The name of an image file (relative to this directory) to place at the top | 
| 123 | 122 | # of the sidebar. | 
| 124 |  | -#html_logo = None | 
|  | 123 | +# html_logo = None | 
| 125 | 124 | 
 | 
| 126 | 125 | # The name of an image file (within the static path) to use as favicon of the | 
| 127 | 126 | # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32 | 
| 128 | 127 | # pixels large. | 
| 129 |  | -#html_favicon = None | 
|  | 128 | +# html_favicon = None | 
| 130 | 129 | 
 | 
| 131 | 130 | # Add any paths that contain custom static files (such as style sheets) here, | 
| 132 | 131 | # relative to this directory. They are copied after the builtin static files, | 
|  | 
| 136 | 135 | # Add any extra paths that contain custom files (such as robots.txt or | 
| 137 | 136 | # .htaccess) here, relative to this directory. These files are copied | 
| 138 | 137 | # directly to the root of the documentation. | 
| 139 |  | -#html_extra_path = [] | 
|  | 138 | +# html_extra_path = [] | 
| 140 | 139 | 
 | 
| 141 | 140 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | 
| 142 | 141 | # using the given strftime format. | 
| 143 |  | -#html_last_updated_fmt = '%b %d, %Y' | 
|  | 142 | +# html_last_updated_fmt = '%b %d, %Y' | 
| 144 | 143 | 
 | 
| 145 | 144 | # If true, SmartyPants will be used to convert quotes and dashes to | 
| 146 | 145 | # typographically correct entities. | 
| 147 |  | -#html_use_smartypants = True | 
|  | 146 | +# html_use_smartypants = True | 
| 148 | 147 | 
 | 
| 149 | 148 | # Custom sidebar templates, maps document names to template names. | 
| 150 |  | -#html_sidebars = {} | 
|  | 149 | +# html_sidebars = {} | 
| 151 | 150 | 
 | 
| 152 | 151 | # Additional templates that should be rendered to pages, maps page names to | 
| 153 | 152 | # template names. | 
| 154 |  | -#html_additional_pages = {} | 
|  | 153 | +# html_additional_pages = {} | 
| 155 | 154 | 
 | 
| 156 | 155 | # If false, no module index is generated. | 
| 157 |  | -#html_domain_indices = True | 
|  | 156 | +# html_domain_indices = True | 
| 158 | 157 | 
 | 
| 159 | 158 | # If false, no index is generated. | 
| 160 |  | -#html_use_index = True | 
|  | 159 | +# html_use_index = True | 
| 161 | 160 | 
 | 
| 162 | 161 | # If true, the index is split into individual pages for each letter. | 
| 163 |  | -#html_split_index = False | 
|  | 162 | +# html_split_index = False | 
| 164 | 163 | 
 | 
| 165 | 164 | # If true, links to the reST sources are added to the pages. | 
| 166 |  | -#html_show_sourcelink = True | 
|  | 165 | +# html_show_sourcelink = True | 
| 167 | 166 | 
 | 
| 168 | 167 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | 
| 169 |  | -#html_show_sphinx = True | 
|  | 168 | +# html_show_sphinx = True | 
| 170 | 169 | 
 | 
| 171 | 170 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | 
| 172 |  | -#html_show_copyright = True | 
|  | 171 | +# html_show_copyright = True | 
| 173 | 172 | 
 | 
| 174 | 173 | # If true, an OpenSearch description file will be output, and all pages will | 
| 175 | 174 | # contain a <link> tag referring to it.  The value of this option must be the | 
| 176 | 175 | # base URL from which the finished HTML is served. | 
| 177 |  | -#html_use_opensearch = '' | 
|  | 176 | +# html_use_opensearch = '' | 
| 178 | 177 | 
 | 
| 179 | 178 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | 
| 180 |  | -#html_file_suffix = None | 
|  | 179 | +# html_file_suffix = None | 
| 181 | 180 | 
 | 
| 182 | 181 | # Output file base name for HTML help builder. | 
| 183 | 182 | htmlhelp_basename = 'tinypagesdoc' | 
|  | 
| 187 | 186 | 
 | 
| 188 | 187 | latex_elements = { | 
| 189 | 188 | # The paper size ('letterpaper' or 'a4paper'). | 
| 190 |  | -#'papersize': 'letterpaper', | 
|  | 189 | +# 'papersize': 'letterpaper', | 
| 191 | 190 | 
 | 
| 192 | 191 | # The font size ('10pt', '11pt' or '12pt'). | 
| 193 |  | -#'pointsize': '10pt', | 
|  | 192 | +# 'pointsize': '10pt', | 
| 194 | 193 | 
 | 
| 195 | 194 | # Additional stuff for the LaTeX preamble. | 
| 196 |  | -#'preamble': '', | 
|  | 195 | +# 'preamble': '', | 
| 197 | 196 | } | 
| 198 | 197 | 
 | 
| 199 | 198 | # Grouping the document tree into LaTeX files. List of tuples | 
|  | 
| 206 | 205 | 
 | 
| 207 | 206 | # The name of an image file (relative to this directory) to place at the top of | 
| 208 | 207 | # the title page. | 
| 209 |  | -#latex_logo = None | 
|  | 208 | +# latex_logo = None | 
| 210 | 209 | 
 | 
| 211 | 210 | # For "manual" documents, if this is true, then toplevel headings are parts, | 
| 212 | 211 | # not chapters. | 
| 213 |  | -#latex_use_parts = False | 
|  | 212 | +# latex_use_parts = False | 
| 214 | 213 | 
 | 
| 215 | 214 | # If true, show page references after internal links. | 
| 216 |  | -#latex_show_pagerefs = False | 
|  | 215 | +# latex_show_pagerefs = False | 
| 217 | 216 | 
 | 
| 218 | 217 | # If true, show URL addresses after external links. | 
| 219 |  | -#latex_show_urls = False | 
|  | 218 | +# latex_show_urls = False | 
| 220 | 219 | 
 | 
| 221 | 220 | # Documents to append as an appendix to all manuals. | 
| 222 |  | -#latex_appendices = [] | 
|  | 221 | +# latex_appendices = [] | 
| 223 | 222 | 
 | 
| 224 | 223 | # If false, no module index is generated. | 
| 225 |  | -#latex_domain_indices = True | 
|  | 224 | +# latex_domain_indices = True | 
| 226 | 225 | 
 | 
| 227 | 226 | 
 | 
| 228 | 227 | # -- Options for manual page output --------------------------------------- | 
|  | 
| 235 | 234 | ] | 
| 236 | 235 | 
 | 
| 237 | 236 | # If true, show URL addresses after external links. | 
| 238 |  | -#man_show_urls = False | 
|  | 237 | +# man_show_urls = False | 
| 239 | 238 | 
 | 
| 240 | 239 | 
 | 
| 241 | 240 | # -- Options for Texinfo output ------------------------------------------- | 
|  | 
| 250 | 249 | ] | 
| 251 | 250 | 
 | 
| 252 | 251 | # Documents to append as an appendix to all manuals. | 
| 253 |  | -#texinfo_appendices = [] | 
|  | 252 | +# texinfo_appendices = [] | 
| 254 | 253 | 
 | 
| 255 | 254 | # If false, no module index is generated. | 
| 256 |  | -#texinfo_domain_indices = True | 
|  | 255 | +# texinfo_domain_indices = True | 
| 257 | 256 | 
 | 
| 258 | 257 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | 
| 259 |  | -#texinfo_show_urls = 'footnote' | 
|  | 258 | +# texinfo_show_urls = 'footnote' | 
| 260 | 259 | 
 | 
| 261 | 260 | # If true, do not generate a @detailmenu in the "Top" node's menu. | 
| 262 |  | -#texinfo_no_detailmenu = False | 
|  | 261 | +# texinfo_no_detailmenu = False | 
0 commit comments