source: sasmodels/doc/conf.py @ 8ae8532

core_shell_microgelscostrafo411magnetic_modelticket-1257-vesicle-productticket_1156ticket_1265_superballticket_822_more_unit_tests
Last change on this file since 8ae8532 was 8ae8532, checked in by Paul Kienzle <pkienzle@…>, 7 years ago

doc reorg

  • Property mode set to 100644
File size: 7.8 KB
Line 
1# -*- coding: utf-8 -*-
2#
3# Periodic Table documentation build configuration file, created by
4# sphinx-quickstart on Tue Jun  2 11:16:08 2009.
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
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#sys.path.append(os.path.abspath('_extensions'+(os.path.dirname('../../periodictable'))))
20
21sys.path.insert(0, os.path.abspath('..'))
22sys.path.insert(0, os.path.abspath('_extensions'))
23sys.path.insert(0, os.path.abspath('.')) # needed for extension tests
24print("\n".join(sys.path))
25import sasmodels
26
27
28# -- General configuration -----------------------------------------------------
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.
32extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
33              'sphinx.ext.coverage',
34              #'sphinx.ext.pngmath',
35              'sphinx.ext.mathjax',
36              #'only_directives',
37              #'matplotlib.sphinxext.mathmpl',
38              'matplotlib.sphinxext.only_directives',
39              'matplotlib.sphinxext.plot_directive',
40              'dollarmath',
41              'numfig',
42             ]
43
44# Redirect mathjax to a different CDN
45mathjax_path = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML"
46
47# Add any paths that contain templates here, relative to this directory.
48templates_path = ['_templates']
49
50# The suffix of source filenames.
51source_suffix = '.rst'
52
53# The encoding of source files.
54#source_encoding = 'utf-8'
55
56# The master toctree document.
57master_doc = 'index'
58
59# General information about the project.
60project = 'SAS Models'
61copyright = '2016, sasview team'
62
63# The version info for the project you're documenting, acts as replacement for
64# |version| and |release|, also used in various other places throughout the
65# built documents.
66#
67# The short X.Y version.
68version = sasmodels.__version__
69# The full version, including alpha/beta/rc tags.
70release = version
71
72# The language for content autogenerated by Sphinx. Refer to documentation
73# for a list of supported languages.
74#language = None
75
76# There are two options for replacing |today|: either, you set today to some
77# non-false value, then it is used:
78#today = ''
79# Else, today_fmt is used as the format for a strftime call.
80#today_fmt = '%B %d, %Y'
81
82# List of documents that shouldn't be included in the build.
83#unused_docs = []
84
85# List of directories, relative to source directory, that shouldn't be searched
86# for source files.
87exclude_trees = ['_*','build','plots']
88
89# The reST default role (used for this markup: `text`) to use for all documents.
90#default_role = None
91
92# If true, '()' will be appended to :func: etc. cross-reference text.
93#add_function_parentheses = True
94
95# If true, the current module name will be prepended to all description
96# unit titles (such as .. function::).
97#add_module_names = True
98
99# If true, sectionauthor and moduleauthor directives will be shown in the
100# output. They are ignored by default.
101#show_authors = False
102
103# The name of the Pygments (syntax highlighting) style to use.
104pygments_style = 'sphinx'
105
106# A list of ignored prefixes for module index sorting.
107#modindex_common_prefix = []
108
109
110# -- Options for HTML output ---------------------------------------------------
111
112# The theme to use for HTML and HTML Help pages.  Major themes that come with
113# Sphinx are currently 'default' and 'sphinxdoc'.
114html_theme = 'haiku'
115html_theme_options = {}
116
117html_style = 'haiku-site.css'
118
119# Theme options are theme-specific and customize the look and feel of a theme
120# further.  For a list of options available for each theme, see the
121# documentation PaleTurquoise.
122#html_theme_options = {}
123
124# Add any paths that contain custom themes here, relative to this directory.
125#html_theme_path = []
126
127# The name for this set of Sphinx documents.  If None, it defaults to
128# "<project> v<release> documentation".
129html_title = "Sasmodels"
130
131# A shorter title for the navigation bar.  Default is the same as html_title.
132html_short_title = "Home"
133
134# The name of an image file (relative to this directory) to place at the top
135# of the sidebar.
136#html_logo = '_static/periodic_logo.png'
137
138# The name of an image file (within the static path) to use as favicon of the
139# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
140# pixels large.
141#html_favicon = None
142
143# Add any paths that contain custom static files (such as style sheets) here,
144# relative to this directory. They are copied after the builtin static files,
145# so a file named "default.css" will overwrite the builtin "default.css".
146html_static_path = ['_static']
147
148# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
149# using the given strftime format.
150#html_last_updated_fmt = '%b %d, %Y'
151
152# If true, SmartyPants will be used to convert quotes and dashes to
153# typographically correct entities.
154#html_use_smartypants = True
155
156# Custom sidebar templates, maps document names to template names.
157#html_sidebars = {}
158
159# Additional templates that should be rendered to pages, maps page names to
160# template names.
161#html_additional_pages = {}
162
163# If false, no module index is generated.
164#html_use_modindex = True
165
166# If false, no index is generated.
167#html_use_index = True
168
169# If true, the index is split into individual pages for each letter.
170#html_split_index = False
171
172# If true, links to the reST sources are added to the pages.
173html_show_sourcelink = False
174
175# If true, an OpenSearch description file will be output, and all pages will
176# contain a <link> tag referring to it.  The value of this option must be the
177# base URL from which the finished HTML is served.
178#html_use_opensearch = ''
179
180# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
181#html_file_suffix = ''
182
183# Output file base name for HTML help builder.
184htmlhelp_basename = 'sasmodelsdoc'
185
186
187# -- Options for LaTeX output --------------------------------------------------
188
189# The paper size ('letter' or 'a4').
190#latex_paper_size = 'letter'
191
192# The font size ('10pt', '11pt' or '12pt').
193#latex_font_size = '10pt'
194
195# Grouping the document tree into LaTeX files. List of tuples
196# (source start file, target name, title, author, documentclass [howto/manual]).
197latex_documents = [
198  ('index', 'SASModels.tex', 'SAS Models Documentation',
199   'sasview team', 'manual'),
200]
201
202# The name of an image file (relative to this directory) to place at the top of
203# the title page.
204#latex_logo = None
205
206# For "manual" documents, if this is true, then toplevel headings are parts,
207# not chapters.
208#latex_use_parts = False
209
210# Additional stuff for the LaTeX preamble.
211#latex_preamble = ''
212LATEX_PREAMBLE=r"""
213\renewcommand{\AA}{\text{\r{A}}} % Allow \AA in math mode
214\usepackage[utf8]{inputenc}      % Allow unicode symbols in text
215\DeclareUnicodeCharacter {00B7} {\ensuremath{\cdot}}   % cdot
216\DeclareUnicodeCharacter {00B0} {\ensuremath{^\circ}}  % degrees
217\DeclareUnicodeCharacter {212B} {\AA}                  % Angstrom
218"""
219latex_elements = {'preamble' : LATEX_PREAMBLE}
220
221# Documents to append as an appendix to all manuals.
222#latex_appendices = []
223
224# If false, no module index is generated.
225#latex_use_modindex = True
226
227# Which class/__init__ docstring to use: class, init, or both
228autoclass_content = 'both'
229
230# Autodoc member sort order: by class or by type
231autodoc_member_order = 'groupwise'
232
233if os.path.exists('rst_prolog'):
234    with open('rst_prolog') as fid:
235        rst_prolog = fid.read()
236
237numfig = True
238#numfig_format = {"figure": "Fig. %s", "table": "Table %s", "code-block": "Program %s"}
Note: See TracBrowser for help on using the repository browser.