# Contents of /trunk/doc/sphinx_api/conf.py

Revision 6949 - (show annotations)
Thu Feb 6 02:36:07 2020 UTC (15 months, 1 week ago) by uqaeller
File MIME type: text/x-python
File size: 9267 byte(s)
Release version 5.5

 1 # -*- coding: utf-8 -*- 2 # 3 # esys documentation build configuration file, created by 4 # sphinx-quickstart on Thu Dec 6 15:14:22 2012. 5 # 6 # This file is execfile()d with the current directory set to its containing dir. 7 # 8 # Note that not all possible configuration values are present in this 9 # autogenerated file. 10 # 11 # All configuration values have a default; values that are commented out 12 # serve to show the default. 13 14 from __future__ import division, print_function 15 16 import sys, os 17 18 # If extensions (or modules to document with autodoc) are in another directory, 19 # add these directories to sys.path here. If the directory is relative to the 20 # documentation root, use os.path.abspath to make it absolute, like shown here. 21 #sys.path.insert(0, os.path.abspath('/home/joel/esys13/esys')) 22 23 # -- General configuration ----------------------------------------------------- 24 25 # If your documentation needs a minimal Sphinx version, state it here. 26 needs_sphinx = '1.0' # For the autodoc_default_flags variable 27 28 autodoc_default_flags=['show-inheritance', 'inherited-members', 'members', 'undoc-members'] 29 30 # Add any Sphinx extension module names here, as strings. They can be extensions 31 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 32 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax'] 33 34 # Add any paths that contain templates here, relative to this directory. 35 templates_path = ['_templates'] 36 37 # The suffix of source filenames. 38 source_suffix = '.rst' 39 40 # The encoding of source files. 41 #source_encoding = 'utf-8-sig' 42 43 # The master toctree document. 44 master_doc = 'index' 45 46 # General information about the project. 47 project = u'esys.escript' 48 copyright = u'2012-2014, Author' 49 50 # The version info for the project you're documenting, acts as replacement for 51 # |version| and |release|, also used in various other places throughout the 52 # built documents. 53 # 54 # The short X.Y version. 55 version = '5.5' 56 # The full version, including alpha/beta/rc tags. 57 release = '5.5' 58 59 # The language for content autogenerated by Sphinx. Refer to documentation 60 # for a list of supported languages. 61 #language = None 62 63 # There are two options for replacing |today|: either, you set today to some 64 # non-false value, then it is used: 65 #today = '' 66 # Else, today_fmt is used as the format for a strftime call. 67 #today_fmt = '%B %d, %Y' 68 69 # List of patterns, relative to source directory, that match files and 70 # directories to ignore when looking for source files. 71 exclude_patterns = ['_build'] 72 73 # The reST default role (used for this markup: text) to use for all documents. 74 default_role = 'obj' 75 76 # If true, '()' will be appended to :func: etc. cross-reference text. 77 #add_function_parentheses = True 78 79 # If true, the current module name will be prepended to all description 80 # unit titles (such as .. function::). 81 #add_module_names = True 82 83 # If true, sectionauthor and moduleauthor directives will be shown in the 84 # output. They are ignored by default. 85 #show_authors = False 86 87 # The name of the Pygments (syntax highlighting) style to use. 88 pygments_style = 'sphinx' 89 90 # A list of ignored prefixes for module index sorting. 91 #modindex_common_prefix = [] 92 93 94 # -- Options for HTML output --------------------------------------------------- 95 96 # The theme to use for HTML and HTML Help pages. See the documentation for 97 # a list of builtin themes. 98 html_theme = 'default' 99 100 # Theme options are theme-specific and customize the look and feel of a theme 101 # further. For a list of options available for each theme, see the 102 # documentation. 103 #html_theme_options = {} 104 105 # Add any paths that contain custom themes here, relative to this directory. 106 #html_theme_path = [] 107 108 # The name for this set of Sphinx documents. If None, it defaults to 109 # " v documentation". 110 #html_title = None 111 112 # A shorter title for the navigation bar. Default is the same as html_title. 113 #html_short_title = None 114 115 # The name of an image file (relative to this directory) to place at the top 116 # of the sidebar. 117 #html_logo = None 118 119 # The name of an image file (within the static path) to use as favicon of the 120 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 121 # pixels large. 122 #html_favicon = None 123 124 # Add any paths that contain custom static files (such as style sheets) here, 125 # relative to this directory. They are copied after the builtin static files, 126 # so a file named "default.css" will overwrite the builtin "default.css". 127 html_static_path = ['_static'] 128 129 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 130 # using the given strftime format. 131 #html_last_updated_fmt = '%b %d, %Y' 132 133 # If true, SmartyPants will be used to convert quotes and dashes to 134 # typographically correct entities. 135 #html_use_smartypants = True 136 137 # Custom sidebar templates, maps document names to template names. 138 html_sidebars = { 139 '**': ['localtoc.html', 'relations.html'] 140 } 141 142 # Additional templates that should be rendered to pages, maps page names to 143 # template names. 144 #html_additional_pages = {} 145 146 # If false, no module index is generated. 147 #html_domain_indices = True 148 149 # If false, no index is generated. 150 #html_use_index = True 151 152 # If true, the index is split into individual pages for each letter. 153 #html_split_index = False 154 155 # If true, links to the reST sources are added to the pages. 156 html_show_sourcelink = False 157 158 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 159 #html_show_sphinx = True 160 161 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 162 #html_show_copyright = True 163 164 # If true, an OpenSearch description file will be output, and all pages will 165 # contain a tag referring to it. The value of this option must be the 166 # base URL from which the finished HTML is served. 167 #html_use_opensearch = '' 168 169 # This is the file name suffix for HTML files (e.g. ".xhtml"). 170 #html_file_suffix = None 171 172 # Output file base name for HTML help builder. 173 htmlhelp_basename = 'esysdoc' 174 175 176 # -- Options for LaTeX output -------------------------------------------------- 177 178 latex_elements = { 179 # The paper size ('letterpaper' or 'a4paper'). 180 #'papersize': 'letterpaper', 181 182 # The font size ('10pt', '11pt' or '12pt'). 183 #'pointsize': '10pt', 184 185 # Additional stuff for the LaTeX preamble. 186 #'preamble': '', 187 } 188 189 # Grouping the document tree into LaTeX files. List of tuples 190 # (source start file, target name, title, author, documentclass [howto/manual]). 191 latex_documents = [ 192 ('index', 'esys.tex', u'esys.escript Documentation', 193 u'Escript Development team', 'manual'), 194 ] 195 196 # The name of an image file (relative to this directory) to place at the top of 197 # the title page. 198 #latex_logo = None 199 200 # For "manual" documents, if this is true, then toplevel headings are parts, 201 # not chapters. 202 #latex_use_parts = False 203 204 # If true, show page references after internal links. 205 #latex_show_pagerefs = False 206 207 # If true, show URL addresses after external links. 208 #latex_show_urls = False 209 210 # Documents to append as an appendix to all manuals. 211 #latex_appendices = [] 212 213 # If false, no module index is generated. 214 #latex_domain_indices = True 215 216 217 # -- Options for manual page output -------------------------------------------- 218 219 # One entry per manual page. List of tuples 220 # (source start file, name, description, authors, manual section). 221 man_pages = [ 222 ('index', 'esys.escript', u'esys.escript Documentation', 223 [u'Author'], 1) 224 ] 225 226 # If true, show URL addresses after external links. 227 #man_show_urls = False 228 229 230 # -- Options for Texinfo output ------------------------------------------------ 231 232 # Grouping the document tree into Texinfo files. List of tuples 233 # (source start file, target name, title, author, 234 # dir menu entry, description, category) 235 texinfo_documents = [ 236 ('index', 'esys.escript', u'esys.escript Documentation', 237 u'Author', 'esys.escript', 'One line description of project.', 238 'Miscellaneous'), 239 ] 240 241 # Documents to append as an appendix to all manuals. 242 #texinfo_appendices = [] 243 244 # If false, no module index is generated. 245 #texinfo_domain_indices = True 246 247 # How to display URL addresses: 'footnote', 'no', or 'inline'. 248 #texinfo_show_urls = 'footnote' 249 250 251 # -- Options for Epub output --------------------------------------------------- 252 253 # Bibliographic Dublin Core info. 254 epub_title = u'esys.escript' 255 epub_author = u'Author' 256 epub_publisher = u'Author' 257 epub_copyright = u'2020, Author' 258 259 # The language of the text. It defaults to the language option 260 # or en if the language is not set. 261 #epub_language = '' 262 263 # The scheme of the identifier. Typical schemes are ISBN or URL. 264 #epub_scheme = '' 265 266 # The unique identifier of the text. This can be a ISBN number 267 # or the project homepage. 268 #epub_identifier = '' 269 270 # A unique identification for the text. 271 #epub_uid = '' 272 273 # A tuple containing the cover image and cover page html template filenames. 274 #epub_cover = () 275 276 # HTML files that should be inserted before the pages created by sphinx. 277 # The format is a list of tuples containing the path and title. 278 #epub_pre_files = [] 279 280 # HTML files shat should be inserted after the pages created by sphinx. 281 # The format is a list of tuples containing the path and title. 282 #epub_post_files = [] 283 284 # A list of files that should not be packed into the epub file. 285 #epub_exclude_files = [] 286 287 # The depth of the table of contents in toc.ncx. 288 #epub_tocdepth = 3 289 290 # Allow duplicate toc entries. 291 #epub_tocdup = True