1 # -*- coding: utf-8 -*- 2 # Copyright 2015-2016 ARM Limited 3 # 4 # Licensed under the Apache License, Version 2.0 (the "License"); 5 # you may not use this file except in compliance with the License. 6 # You may obtain a copy of the License at 7 # 8 # http://www.apache.org/licenses/LICENSE-2.0 9 # 10 # Unless required by applicable law or agreed to in writing, software 11 # distributed under the License is distributed on an "AS IS" BASIS, 12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 # See the License for the specific language governing permissions and 14 # limitations under the License. 15 # 16 17 # BART documentation build configuration file, created by 18 # sphinx-quickstart on Fri Sep 4 11:30:35 2015. 19 # 20 # This file is execfile()d with the current directory set to its 21 # containing dir. 22 # 23 # Note that not all possible configuration values are present in this 24 # autogenerated file. 25 # 26 # All configuration values have a default; values that are commented out 27 # serve to show the default. 28 29 import sys 30 import os 31 import shlex 32 33 this_dir = os.path.dirname(__file__) 34 sys.path.insert(0, os.path.join(this_dir, '../..')) 35 import bart 36 37 # If extensions (or modules to document with autodoc) are in another directory, 38 # add these directories to sys.path here. If the directory is relative to the 39 # documentation root, use os.path.abspath to make it absolute, like shown here. 40 #sys.path.insert(0, os.path.abspath('.')) 41 42 # -- General configuration ------------------------------------------------ 43 44 # If your documentation needs a minimal Sphinx version, state it here. 45 #needs_sphinx = '1.0' 46 47 # Add any Sphinx extension module names here, as strings. They can be 48 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 49 # ones. 50 extensions = [ 51 'sphinx.ext.autodoc', 52 'sphinx.ext.todo', 53 'sphinx.ext.coverage', 54 'sphinx.ext.mathjax', 55 'sphinx.ext.ifconfig', 56 'sphinx.ext.viewcode'] 57 58 # Update MathJax path to use the cdnjs using HTTPS 59 mathjax_path = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" 60 61 # Add any paths that contain templates here, relative to this directory. 62 templates_path = ['_templates'] 63 64 # The suffix(es) of source filenames. 65 # You can specify multiple suffix as a list of string: 66 # source_suffix = ['.rst', '.md'] 67 source_suffix = '.rst' 68 69 # The encoding of source files. 70 #source_encoding = 'utf-8-sig' 71 72 # The master toctree document. 73 master_doc = 'index' 74 75 # General information about the project. 76 project = u'BART' 77 copyright = u'2016, ARM Ltd.' 78 author = u'Kapileshwar Singh(KP), Javi Merino' 79 80 # The version info for the project you're documenting, acts as replacement for 81 # |version| and |release|, also used in various other places throughout the 82 # built documents. 83 # 84 # The short X.Y version. Drop everything after the last "." 85 version = bart.__version__[:bart.__version__.rindex(".")] 86 # The full version, including alpha/beta/rc tags. 87 release = bart.__version__ 88 89 # The language for content autogenerated by Sphinx. Refer to documentation 90 # for a list of supported languages. 91 # 92 # This is also used if you do content translation via gettext catalogs. 93 # Usually you set "language" from the command line for these cases. 94 language = 'en' 95 96 # There are two options for replacing |today|: either, you set today to some 97 # non-false value, then it is used: 98 #today = '' 99 # Else, today_fmt is used as the format for a strftime call. 100 #today_fmt = '%B %d, %Y' 101 102 # List of patterns, relative to source directory, that match files and 103 # directories to ignore when looking for source files. 104 exclude_patterns = ['_build'] 105 106 # The reST default role (used for this markup: `text`) to use for all 107 # documents. 108 #default_role = None 109 110 # If true, '()' will be appended to :func: etc. cross-reference text. 111 #add_function_parentheses = True 112 113 # If true, the current module name will be prepended to all description 114 # unit titles (such as .. function::). 115 #add_module_names = True 116 117 # If true, sectionauthor and moduleauthor directives will be shown in the 118 # output. They are ignored by default. 119 #show_authors = False 120 121 # The name of the Pygments (syntax highlighting) style to use. 122 pygments_style = 'sphinx' 123 124 # A list of ignored prefixes for module index sorting. 125 #modindex_common_prefix = [] 126 127 # If true, keep warnings as "system message" paragraphs in the built documents. 128 #keep_warnings = False 129 130 # If true, `todo` and `todoList` produce output, else they produce nothing. 131 todo_include_todos = True 132 133 134 # -- Options for HTML output ---------------------------------------------- 135 136 # The theme to use for HTML and HTML Help pages. See the documentation for 137 # a list of builtin themes. 138 html_theme = 'classic' 139 140 # Theme options are theme-specific and customize the look and feel of a theme 141 # further. For a list of options available for each theme, see the 142 # documentation. 143 #html_theme_options = {} 144 145 # Add any paths that contain custom themes here, relative to this directory. 146 #html_theme_path = [] 147 148 # The name for this set of Sphinx documents. If None, it defaults to 149 # "<project> v<release> documentation". 150 #html_title = None 151 152 # A shorter title for the navigation bar. Default is the same as html_title. 153 #html_short_title = None 154 155 # The name of an image file (relative to this directory) to place at the top 156 # of the sidebar. 157 #html_logo = None 158 159 # The name of an image file (within the static path) to use as favicon of the 160 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 161 # pixels large. 162 #html_favicon = None 163 164 # Add any paths that contain custom static files (such as style sheets) here, 165 # relative to this directory. They are copied after the builtin static files, 166 # so a file named "default.css" will overwrite the builtin "default.css". 167 html_static_path = ['_static'] 168 169 # Add any extra paths that contain custom files (such as robots.txt or 170 # .htaccess) here, relative to this directory. These files are copied 171 # directly to the root of the documentation. 172 #html_extra_path = [] 173 174 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 175 # using the given strftime format. 176 #html_last_updated_fmt = '%b %d, %Y' 177 178 # If true, SmartyPants will be used to convert quotes and dashes to 179 # typographically correct entities. 180 #html_use_smartypants = True 181 182 # Custom sidebar templates, maps document names to template names. 183 #html_sidebars = {} 184 185 # Additional templates that should be rendered to pages, maps page names to 186 # template names. 187 #html_additional_pages = {} 188 189 # If false, no module index is generated. 190 #html_domain_indices = True 191 192 # If false, no index is generated. 193 #html_use_index = True 194 195 # If true, the index is split into individual pages for each letter. 196 #html_split_index = False 197 198 # If true, links to the reST sources are added to the pages. 199 #html_show_sourcelink = True 200 201 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 202 #html_show_sphinx = True 203 204 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 205 #html_show_copyright = True 206 207 # If true, an OpenSearch description file will be output, and all pages will 208 # contain a <link> tag referring to it. The value of this option must be the 209 # base URL from which the finished HTML is served. 210 #html_use_opensearch = '' 211 212 # This is the file name suffix for HTML files (e.g. ".xhtml"). 213 #html_file_suffix = None 214 215 # Language to be used for generating the HTML full-text search index. 216 # Sphinx supports the following languages: 217 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' 218 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' 219 #html_search_language = 'en' 220 221 # A dictionary with options for the search language support, empty by default. 222 # Now only 'ja' uses this config value 223 #html_search_options = {'type': 'default'} 224 225 # The name of a javascript file (relative to the configuration directory) that 226 # implements a search results scorer. If empty, the default will be used. 227 #html_search_scorer = 'scorer.js' 228 229 # Output file base name for HTML help builder. 230 htmlhelp_basename = 'BARTdoc' 231 232 # -- Options for LaTeX output --------------------------------------------- 233 234 latex_elements = { 235 # The paper size ('letterpaper' or 'a4paper'). 236 #'papersize': 'letterpaper', 237 238 # The font size ('10pt', '11pt' or '12pt'). 239 #'pointsize': '10pt', 240 241 # Additional stuff for the LaTeX preamble. 242 #'preamble': '', 243 244 # Latex figure (float) alignment 245 #'figure_align': 'htbp', 246 } 247 248 # Grouping the document tree into LaTeX files. List of tuples 249 # (source start file, target name, title, 250 # author, documentclass [howto, manual, or own class]). 251 latex_documents = [ 252 (master_doc, 'BART.tex', u'BART Documentation', 253 u'Kapileshwar Singh(KP), Javi Merino', 'manual'), 254 ] 255 256 # The name of an image file (relative to this directory) to place at the top of 257 # the title page. 258 #latex_logo = None 259 260 # For "manual" documents, if this is true, then toplevel headings are parts, 261 # not chapters. 262 #latex_use_parts = False 263 264 # If true, show page references after internal links. 265 #latex_show_pagerefs = False 266 267 # If true, show URL addresses after external links. 268 #latex_show_urls = False 269 270 # Documents to append as an appendix to all manuals. 271 #latex_appendices = [] 272 273 # If false, no module index is generated. 274 #latex_domain_indices = True 275 276 277 # -- Options for manual page output --------------------------------------- 278 279 # One entry per manual page. List of tuples 280 # (source start file, name, description, authors, manual section). 281 man_pages = [ 282 (master_doc, 'bart', u'BART Documentation', 283 [author], 1) 284 ] 285 286 # If true, show URL addresses after external links. 287 #man_show_urls = False 288 289 290 # -- Options for Texinfo output ------------------------------------------- 291 292 # Grouping the document tree into Texinfo files. List of tuples 293 # (source start file, target name, title, author, 294 # dir menu entry, description, category) 295 texinfo_documents = [ 296 (master_doc, 'BART', u'BART Documentation', 297 author, 'BART', 'One line description of project.', 298 'Miscellaneous'), 299 ] 300 301 # Documents to append as an appendix to all manuals. 302 #texinfo_appendices = [] 303 304 # If false, no module index is generated. 305 #texinfo_domain_indices = True 306 307 # How to display URL addresses: 'footnote', 'no', or 'inline'. 308 #texinfo_show_urls = 'footnote' 309 310 # If true, do not generate a @detailmenu in the "Top" node's menu. 311 #texinfo_no_detailmenu = False 312 313 314 # -- Options for Epub output ---------------------------------------------- 315 316 # Bibliographic Dublin Core info. 317 epub_title = project 318 epub_author = author 319 epub_publisher = author 320 epub_copyright = copyright 321 322 # The basename for the epub file. It defaults to the project name. 323 #epub_basename = project 324 325 # The HTML theme for the epub output. Since the default themes are not optimized 326 # for small screen space, using the same theme for HTML and epub output is 327 # usually not wise. This defaults to 'epub', a theme designed to save visual 328 # space. 329 #epub_theme = 'epub' 330 331 # The language of the text. It defaults to the language option 332 # or 'en' if the language is not set. 333 #epub_language = '' 334 335 # The scheme of the identifier. Typical schemes are ISBN or URL. 336 #epub_scheme = '' 337 338 # The unique identifier of the text. This can be a ISBN number 339 # or the project homepage. 340 #epub_identifier = '' 341 342 # A unique identification for the text. 343 #epub_uid = '' 344 345 # A tuple containing the cover image and cover page html template filenames. 346 #epub_cover = () 347 348 # A sequence of (type, uri, title) tuples for the guide element of content.opf. 349 #epub_guide = () 350 351 # HTML files that should be inserted before the pages created by sphinx. 352 # The format is a list of tuples containing the path and title. 353 #epub_pre_files = [] 354 355 # HTML files shat should be inserted after the pages created by sphinx. 356 # The format is a list of tuples containing the path and title. 357 #epub_post_files = [] 358 359 # A list of files that should not be packed into the epub file. 360 epub_exclude_files = ['search.html'] 361 362 # The depth of the table of contents in toc.ncx. 363 #epub_tocdepth = 3 364 365 # Allow duplicate toc entries. 366 #epub_tocdup = True 367 368 # Choose between 'default' and 'includehidden'. 369 #epub_tocscope = 'default' 370 371 # Fix unsupported image types using the Pillow. 372 #epub_fix_images = False 373 374 # Scale large images. 375 #epub_max_image_width = 0 376 377 # How to display URL addresses: 'footnote', 'no', or 'inline'. 378 #epub_show_urls = 'inline' 379 380 # If false, no index is generated. 381 #epub_use_index = True 382