source: sasview/docs/sphinx-docs/source/conf.py @ 36303ee

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalcmagnetic_scattrelease-4.1.1release-4.1.2release-4.2.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 36303ee was 36303ee, checked in by butler, 7 years ago

Try to fix rendering using new CDN link. addresses #948

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