source: sasmodels/doc/conf.py @ 40a87fa

core_shell_microgelscostrafo411magnetic_modelrelease_v0.94release_v0.95ticket-1257-vesicle-productticket_1156ticket_1265_superballticket_822_more_unit_tests
Last change on this file since 40a87fa was 40a87fa, checked in by Paul Kienzle <pkienzle@…>, 8 years ago

lint and latex cleanup

  • Property mode set to 100644
File size: 7.7 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# 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'
52
53# The master toctree document.
54master_doc = 'index'
55
56# General information about the project.
57project = 'SAS Models'
58copyright = '2016, sasview team'
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 = sasmodels.__version__
66# The full version, including alpha/beta/rc tags.
67release = version
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 documents that shouldn't be included in the build.
80#unused_docs = []
81
82# List of directories, relative to source directory, that shouldn't be searched
83# for source files.
84exclude_trees = ['_*','build','plots']
85
86# The reST default role (used for this markup: `text`) to use for all documents.
87#default_role = None
88
89# If true, '()' will be appended to :func: etc. cross-reference text.
90#add_function_parentheses = True
91
92# If true, the current module name will be prepended to all description
93# unit titles (such as .. function::).
94#add_module_names = True
95
96# If true, sectionauthor and moduleauthor directives will be shown in the
97# output. They are ignored by default.
98#show_authors = False
99
100# The name of the Pygments (syntax highlighting) style to use.
101pygments_style = 'sphinx'
102
103# A list of ignored prefixes for module index sorting.
104#modindex_common_prefix = []
105
106
107# -- Options for HTML output ---------------------------------------------------
108
109# The theme to use for HTML and HTML Help pages.  Major themes that come with
110# Sphinx are currently 'default' and 'sphinxdoc'.
111html_theme = 'haiku'
112html_theme_options = {}
113
114html_style = 'haiku-site.css'
115
116# Theme options are theme-specific and customize the look and feel of a theme
117# further.  For a list of options available for each theme, see the
118# documentation PaleTurquoise.
119#html_theme_options = {}
120
121# Add any paths that contain custom themes here, relative to this directory.
122#html_theme_path = []
123
124# The name for this set of Sphinx documents.  If None, it defaults to
125# "<project> v<release> documentation".
126html_title = "Sasmodels"
127
128# A shorter title for the navigation bar.  Default is the same as html_title.
129html_short_title = "Home"
130
131# The name of an image file (relative to this directory) to place at the top
132# of the sidebar.
133#html_logo = '_static/periodic_logo.png'
134
135# The name of an image file (within the static path) to use as favicon of the
136# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
137# pixels large.
138#html_favicon = None
139
140# Add any paths that contain custom static files (such as style sheets) here,
141# relative to this directory. They are copied after the builtin static files,
142# so a file named "default.css" will overwrite the builtin "default.css".
143html_static_path = ['_static']
144
145# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
146# using the given strftime format.
147#html_last_updated_fmt = '%b %d, %Y'
148
149# If true, SmartyPants will be used to convert quotes and dashes to
150# typographically correct entities.
151#html_use_smartypants = True
152
153# Custom sidebar templates, maps document names to template names.
154#html_sidebars = {}
155
156# Additional templates that should be rendered to pages, maps page names to
157# template names.
158#html_additional_pages = {}
159
160# If false, no module index is generated.
161#html_use_modindex = True
162
163# If false, no index is generated.
164#html_use_index = True
165
166# If true, the index is split into individual pages for each letter.
167#html_split_index = False
168
169# If true, links to the reST sources are added to the pages.
170html_show_sourcelink = False
171
172# If true, an OpenSearch description file will be output, and all pages will
173# contain a <link> tag referring to it.  The value of this option must be the
174# base URL from which the finished HTML is served.
175#html_use_opensearch = ''
176
177# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
178#html_file_suffix = ''
179
180# Output file base name for HTML help builder.
181htmlhelp_basename = 'sasmodelsdoc'
182
183
184# -- Options for LaTeX output --------------------------------------------------
185
186# The paper size ('letter' or 'a4').
187#latex_paper_size = 'letter'
188
189# The font size ('10pt', '11pt' or '12pt').
190#latex_font_size = '10pt'
191
192# Grouping the document tree into LaTeX files. List of tuples
193# (source start file, target name, title, author, documentclass [howto/manual]).
194latex_documents = [
195  ('index', 'SASModels.tex', 'SAS Models Documentation',
196   'sasview team', 'manual'),
197]
198
199# The name of an image file (relative to this directory) to place at the top of
200# the title page.
201#latex_logo = None
202
203# For "manual" documents, if this is true, then toplevel headings are parts,
204# not chapters.
205#latex_use_parts = False
206
207# Additional stuff for the LaTeX preamble.
208#latex_preamble = ''
209LATEX_PREAMBLE=r"""
210\renewcommand{\AA}{\text{\r{A}}} % Allow \AA in math mode
211\usepackage[utf8]{inputenc}      % Allow unicode symbols in text
212\DeclareUnicodeCharacter {00B7} {\ensuremath{\cdot}}   % cdot
213\DeclareUnicodeCharacter {00B0} {\ensuremath{^\circ}}  % degrees
214\DeclareUnicodeCharacter {212B} {\AA}                  % Angstrom
215"""
216latex_elements = {'preamble' : LATEX_PREAMBLE}
217
218# Documents to append as an appendix to all manuals.
219#latex_appendices = []
220
221# If false, no module index is generated.
222#latex_use_modindex = True
223
224# Which class/__init__ docstring to use: class, init, or both
225autoclass_content = 'both'
226
227# Autodoc member sort order: by class or by type
228autodoc_member_order = 'groupwise'
229
230if os.path.exists('rst_prolog'):
231    with open('rst_prolog') as fid:
232        rst_prolog = fid.read()
233
234numfig = True
235#numfig_format = {"figure": "Fig. %s", "table": "Table %s", "code-block": "Program %s"}
Note: See TracBrowser for help on using the repository browser.