[9dfb1f9] | 1 | # -*- coding: utf-8 -*- |
---|
| 2 | # |
---|
| 3 | # SasView documentation build configuration file, created by |
---|
| 4 | # sphinx-quickstart on Wed Aug 28 14:59:44 2013. |
---|
| 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 | import sys, os, collections |
---|
| 15 | |
---|
| 16 | # If extensions (or modules to document with autodoc) are in another directory, |
---|
| 17 | # add these directories to sys.path here. If the directory is relative to the |
---|
| 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
---|
| 19 | from distutils.util import get_platform |
---|
| 20 | platform = '.%s-%s'%(get_platform(),sys.version[:3]) |
---|
| 21 | build_lib = os.path.abspath('../../../build/lib'+platform) |
---|
| 22 | sys.path.insert(0, build_lib) |
---|
[eff1ad80] | 23 | print "-- path --" |
---|
| 24 | print "\n".join(sys.path) |
---|
[9dfb1f9] | 25 | |
---|
| 26 | # -- General configuration ----------------------------------------------------- |
---|
| 27 | |
---|
| 28 | # If your documentation needs a minimal Sphinx version, state it here. |
---|
| 29 | #needs_sphinx = '1.0' |
---|
| 30 | |
---|
| 31 | # Add any Sphinx extension module names here, as strings. They can be extensions |
---|
| 32 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
---|
| 33 | extensions = ['sphinx.ext.autodoc', |
---|
| 34 | 'sphinx.ext.todo', |
---|
| 35 | 'sphinx.ext.coverage', |
---|
| 36 | 'sphinx.ext.mathjax', |
---|
| 37 | 'sphinx.ext.viewcode'] |
---|
| 38 | |
---|
| 39 | # Add any paths that contain templates here, relative to this directory. |
---|
| 40 | templates_path = ['_templates'] |
---|
| 41 | |
---|
| 42 | # The suffix of source filenames. |
---|
| 43 | source_suffix = '.rst' |
---|
| 44 | |
---|
| 45 | # The encoding of source files. |
---|
| 46 | #source_encoding = 'utf-8-sig' |
---|
| 47 | |
---|
| 48 | # The master toctree document. |
---|
| 49 | master_doc = 'index' |
---|
| 50 | |
---|
| 51 | # General information about the project. |
---|
| 52 | project = u'SasView' |
---|
| 53 | copyright = u'2013, The SasView Project' |
---|
| 54 | |
---|
| 55 | # The version info for the project you're documenting, acts as replacement for |
---|
| 56 | # |version| and |release|, also used in various other places throughout the |
---|
| 57 | # built documents. |
---|
| 58 | # |
---|
| 59 | # The short X.Y version. |
---|
| 60 | version = '3.0.0' |
---|
| 61 | # The full version, including alpha/beta/rc tags. |
---|
| 62 | release = '3.0.0' |
---|
| 63 | |
---|
| 64 | # The language for content autogenerated by Sphinx. Refer to documentation |
---|
| 65 | # for a list of supported languages. |
---|
| 66 | #language = None |
---|
| 67 | |
---|
| 68 | # There are two options for replacing |today|: either, you set today to some |
---|
| 69 | # non-false value, then it is used: |
---|
| 70 | #today = '' |
---|
| 71 | # Else, today_fmt is used as the format for a strftime call. |
---|
| 72 | #today_fmt = '%B %d, %Y' |
---|
| 73 | |
---|
| 74 | # List of patterns, relative to source directory, that match files and |
---|
| 75 | # directories to ignore when looking for source files. |
---|
| 76 | # |
---|
| 77 | # PGP 2014/04/03: We have some code which doesn't get carried over to |
---|
| 78 | # the build directory. Exclude the appropriate *.rst files here so |
---|
| 79 | # that we don't get various "ImportError: No module named ___" when |
---|
| 80 | # running Sphinx. |
---|
[3a39c2e] | 81 | exclude_patterns = ["*sas.perspectives.simulation.rst", |
---|
| 82 | "*sas.pr.c_extensions.rst", |
---|
| 83 | "*sas.realspace.rst", |
---|
| 84 | "*sas.simulation.rst", |
---|
[e27d71b] | 85 | "*park.fitmc.rst", |
---|
| 86 | "*park.fitservice.rst", |
---|
| 87 | "*park.parksnob.rst", |
---|
| 88 | "*park.rangemap.rst", |
---|
[3a39c2e] | 89 | "*sas.sasview.setup_exe.rst", |
---|
| 90 | "*sas.sasview.setup_mac.rst", |
---|
| 91 | "*sas.guiframe.custom_pstats.rst", # pstats not in standard library on Ubuntu out of the box |
---|
[e27d71b] | 92 | ] |
---|
[9dfb1f9] | 93 | |
---|
| 94 | # The reST default role (used for this markup: `text`) to use for all documents. |
---|
| 95 | #default_role = None |
---|
| 96 | |
---|
| 97 | # If true, '()' will be appended to :func: etc. cross-reference text. |
---|
| 98 | #add_function_parentheses = True |
---|
| 99 | |
---|
| 100 | # If true, the current module name will be prepended to all description |
---|
| 101 | # unit titles (such as .. function::). |
---|
| 102 | #add_module_names = True |
---|
| 103 | |
---|
| 104 | # If true, sectionauthor and moduleauthor directives will be shown in the |
---|
| 105 | # output. They are ignored by default. |
---|
| 106 | #show_authors = False |
---|
| 107 | |
---|
| 108 | # The name of the Pygments (syntax highlighting) style to use. |
---|
| 109 | pygments_style = 'sphinx' |
---|
| 110 | |
---|
| 111 | # A list of ignored prefixes for module index sorting. |
---|
| 112 | #modindex_common_prefix = [] |
---|
| 113 | |
---|
| 114 | # If true, keep warnings as "system message" paragraphs in the built documents. |
---|
| 115 | #keep_warnings = False |
---|
| 116 | |
---|
| 117 | |
---|
| 118 | # -- Options for HTML output --------------------------------------------------- |
---|
| 119 | |
---|
| 120 | # The theme to use for HTML and HTML Help pages. See the documentation for |
---|
| 121 | # a list of builtin themes. |
---|
| 122 | html_theme = 'default' |
---|
| 123 | |
---|
| 124 | # Theme options are theme-specific and customize the look and feel of a theme |
---|
| 125 | # further. For a list of options available for each theme, see the |
---|
| 126 | # documentation. |
---|
| 127 | #html_theme_options = {} |
---|
| 128 | |
---|
| 129 | # Add any paths that contain custom themes here, relative to this directory. |
---|
| 130 | #html_theme_path = [] |
---|
| 131 | |
---|
| 132 | # The name for this set of Sphinx documents. If None, it defaults to |
---|
| 133 | # "<project> v<release> documentation". |
---|
| 134 | #html_title = None |
---|
| 135 | |
---|
| 136 | # A shorter title for the navigation bar. Default is the same as html_title. |
---|
| 137 | #html_short_title = None |
---|
| 138 | |
---|
| 139 | # The name of an image file (relative to this directory) to place at the top |
---|
| 140 | # of the sidebar. |
---|
| 141 | #html_logo = None |
---|
| 142 | |
---|
| 143 | # The name of an image file (within the static path) to use as favicon of the |
---|
| 144 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
---|
| 145 | # pixels large. |
---|
| 146 | #html_favicon = None |
---|
| 147 | |
---|
| 148 | # Add any paths that contain custom static files (such as style sheets) here, |
---|
| 149 | # relative to this directory. They are copied after the builtin static files, |
---|
| 150 | # so a file named "default.css" will overwrite the builtin "default.css". |
---|
| 151 | html_static_path = ['_static'] |
---|
| 152 | |
---|
| 153 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
---|
| 154 | # using the given strftime format. |
---|
| 155 | #html_last_updated_fmt = '%b %d, %Y' |
---|
| 156 | |
---|
| 157 | # If true, SmartyPants will be used to convert quotes and dashes to |
---|
| 158 | # typographically correct entities. |
---|
| 159 | #html_use_smartypants = True |
---|
| 160 | |
---|
| 161 | # Custom sidebar templates, maps document names to template names. |
---|
| 162 | #html_sidebars = {} |
---|
| 163 | |
---|
| 164 | # Additional templates that should be rendered to pages, maps page names to |
---|
| 165 | # template names. |
---|
| 166 | #html_additional_pages = {} |
---|
| 167 | |
---|
| 168 | # If false, no module index is generated. |
---|
| 169 | #html_domain_indices = True |
---|
| 170 | |
---|
| 171 | # If false, no index is generated. |
---|
| 172 | #html_use_index = True |
---|
| 173 | |
---|
| 174 | # If true, the index is split into individual pages for each letter. |
---|
| 175 | #html_split_index = False |
---|
| 176 | |
---|
| 177 | # If true, links to the reST sources are added to the pages. |
---|
| 178 | #html_show_sourcelink = True |
---|
| 179 | |
---|
| 180 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
---|
| 181 | #html_show_sphinx = True |
---|
| 182 | |
---|
| 183 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
---|
| 184 | #html_show_copyright = True |
---|
| 185 | |
---|
| 186 | # If true, an OpenSearch description file will be output, and all pages will |
---|
| 187 | # contain a <link> tag referring to it. The value of this option must be the |
---|
| 188 | # base URL from which the finished HTML is served. |
---|
| 189 | #html_use_opensearch = '' |
---|
| 190 | |
---|
| 191 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
---|
| 192 | #html_file_suffix = None |
---|
| 193 | |
---|
| 194 | # Output file base name for HTML help builder. |
---|
| 195 | htmlhelp_basename = 'SasViewdoc' |
---|
| 196 | |
---|
| 197 | # Turn off permalinks, which are a nice feature for the docs when viewed in a |
---|
| 198 | # browser, but which look weird (and cannot be "right-click->copy url") in |
---|
| 199 | # the SasView help. |
---|
| 200 | html_add_permalinks = "" |
---|
| 201 | |
---|
| 202 | |
---|
| 203 | # -- Options for LaTeX output -------------------------------------------------- |
---|
| 204 | |
---|
| 205 | latex_elements = { |
---|
| 206 | # The paper size ('letterpaper' or 'a4paper'). |
---|
| 207 | #'papersize': 'letterpaper', |
---|
| 208 | |
---|
| 209 | # The font size ('10pt', '11pt' or '12pt'). |
---|
| 210 | #'pointsize': '10pt', |
---|
| 211 | |
---|
| 212 | # Additional stuff for the LaTeX preamble. |
---|
| 213 | #'preamble': '', |
---|
| 214 | } |
---|
| 215 | |
---|
| 216 | # Grouping the document tree into LaTeX files. List of tuples |
---|
| 217 | # (source start file, target name, title, author, documentclass [howto/manual]). |
---|
| 218 | latex_documents = [ |
---|
| 219 | ('index', 'SasView.tex', u'SasView Documentation', |
---|
| 220 | u'The SasView Project', 'manual'), |
---|
| 221 | ] |
---|
| 222 | |
---|
| 223 | # The name of an image file (relative to this directory) to place at the top of |
---|
| 224 | # the title page. |
---|
| 225 | #latex_logo = None |
---|
| 226 | |
---|
| 227 | # For "manual" documents, if this is true, then toplevel headings are parts, |
---|
| 228 | # not chapters. |
---|
| 229 | #latex_use_parts = False |
---|
| 230 | |
---|
| 231 | # If true, show page references after internal links. |
---|
| 232 | #latex_show_pagerefs = False |
---|
| 233 | |
---|
| 234 | # If true, show URL addresses after external links. |
---|
| 235 | #latex_show_urls = False |
---|
| 236 | |
---|
| 237 | # Documents to append as an appendix to all manuals. |
---|
| 238 | #latex_appendices = [] |
---|
| 239 | |
---|
| 240 | # If false, no module index is generated. |
---|
| 241 | #latex_domain_indices = True |
---|
| 242 | |
---|
| 243 | |
---|
| 244 | # -- Options for manual page output -------------------------------------------- |
---|
| 245 | |
---|
| 246 | # One entry per manual page. List of tuples |
---|
| 247 | # (source start file, name, description, authors, manual section). |
---|
| 248 | man_pages = [ |
---|
| 249 | ('index', 'sasview', u'SasView Documentation', |
---|
| 250 | [u'The SasView Project'], 1) |
---|
| 251 | ] |
---|
| 252 | |
---|
| 253 | # If true, show URL addresses after external links. |
---|
| 254 | #man_show_urls = False |
---|
| 255 | |
---|
| 256 | |
---|
| 257 | # -- Options for Texinfo output ------------------------------------------------ |
---|
| 258 | |
---|
| 259 | # Grouping the document tree into Texinfo files. List of tuples |
---|
| 260 | # (source start file, target name, title, author, |
---|
| 261 | # dir menu entry, description, category) |
---|
| 262 | texinfo_documents = [ |
---|
| 263 | ('index', 'SasView', u'SasView Documentation', |
---|
| 264 | u'The SasView Project', 'SasView', 'One line description of project.', |
---|
| 265 | 'Miscellaneous'), |
---|
| 266 | ] |
---|
| 267 | |
---|
| 268 | # Documents to append as an appendix to all manuals. |
---|
| 269 | #texinfo_appendices = [] |
---|
| 270 | |
---|
| 271 | # If false, no module index is generated. |
---|
| 272 | #texinfo_domain_indices = True |
---|
| 273 | |
---|
| 274 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
---|
| 275 | #texinfo_show_urls = 'footnote' |
---|
| 276 | |
---|
| 277 | # If true, do not generate a @detailmenu in the "Top" node's menu. |
---|
| 278 | #texinfo_no_detailmenu = False |
---|