source: sasview/pr_inversion/docs/sphinx/conf.py @ ff06528

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since ff06528 was d84a90c, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation

  • Property mode set to 100644
File size: 7.2 KB
Line 
1# -*- coding: utf-8 -*-
2#
3# pr_inversion documentation build configuration file, created by
4# sphinx-quickstart on Thu Jun 03 15:34:41 2010.
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.
19sys.path.append(os.path.abspath(os.path.dirname('../../pr_inversion')))
20sys.path.append(os.path.abspath('_extensions'))
21
22
23# -- General configuration -----------------------------------------------------
24
25# Add any Sphinx extension module names here, as strings. They can be extensions
26# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
27extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
28              'sphinx.ext.coverage', 'sphinx.ext.pngmath',
29              'only_directives',             
30             ]
31
32# Add any paths that contain templates here, relative to this directory.
33templates_path = ['_templates']
34
35# The suffix of source filenames.
36source_suffix = '.rst'
37
38# The encoding of source files.
39#source_encoding = 'utf-8-sig'
40
41# The master toctree document.
42master_doc = 'index'
43
44# General information about the project.
45project = u'pr_inversion'
46copyright = u'2010, sans group'
47
48# The version info for the project you're documenting, acts as replacement for
49# |version| and |release|, also used in various other places throughout the
50# built documents.
51#
52# The short X.Y version.
53version = '0.1'
54# The full version, including alpha/beta/rc tags.
55release = '0.1.0'
56
57# The language for content autogenerated by Sphinx. Refer to documentation
58# for a list of supported languages.
59#language = None
60
61# There are two options for replacing |today|: either, you set today to some
62# non-false value, then it is used:
63#today = ''
64# Else, today_fmt is used as the format for a strftime call.
65#today_fmt = '%B %d, %Y'
66
67# List of patterns, relative to source directory, that match files and
68# directories to ignore when looking for source files.
69exclude_patterns = ['_build']
70
71# The reST default role (used for this markup: `text`) to use for all documents.
72#default_role = None
73
74# If true, '()' will be appended to :func: etc. cross-reference text.
75#add_function_parentheses = True
76
77# If true, the current module name will be prepended to all description
78# unit titles (such as .. function::).
79#add_module_names = True
80
81# If true, sectionauthor and moduleauthor directives will be shown in the
82# output. They are ignored by default.
83#show_authors = False
84
85# The name of the Pygments (syntax highlighting) style to use.
86pygments_style = 'sphinx'
87
88# A list of ignored prefixes for module index sorting.
89#modindex_common_prefix = []
90
91
92# -- Options for HTML output ---------------------------------------------------
93
94# The theme to use for HTML and HTML Help pages.  Major themes that come with
95# Sphinx are currently 'default' and 'sphinxdoc'.
96html_theme = 'default'
97
98# Theme options are theme-specific and customize the look and feel of a theme
99# further.  For a list of options available for each theme, see the
100# documentation.
101#html_theme_options = {}
102
103# Add any paths that contain custom themes here, relative to this directory.
104#html_theme_path = []
105
106# The name for this set of Sphinx documents.  If None, it defaults to
107# "<project> v<release> documentation".
108#html_title = None
109
110# A shorter title for the navigation bar.  Default is the same as html_title.
111#html_short_title = None
112
113# The name of an image file (relative to this directory) to place at the top
114# of the sidebar.
115#html_logo = None
116
117# The name of an image file (within the static path) to use as favicon of the
118# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
119# pixels large.
120#html_favicon = None
121
122# Add any paths that contain custom static files (such as style sheets) here,
123# relative to this directory. They are copied after the builtin static files,
124# so a file named "default.css" will overwrite the builtin "default.css".
125html_static_path = ['_static']
126
127# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128# using the given strftime format.
129#html_last_updated_fmt = '%b %d, %Y'
130
131# If true, SmartyPants will be used to convert quotes and dashes to
132# typographically correct entities.
133#html_use_smartypants = True
134
135# Custom sidebar templates, maps document names to template names.
136#html_sidebars = {}
137
138# Additional templates that should be rendered to pages, maps page names to
139# template names.
140#html_additional_pages = {}
141
142# If false, no module index is generated.
143#html_domain_indices = True
144
145# If false, no index is generated.
146#html_use_index = True
147
148# If true, the index is split into individual pages for each letter.
149#html_split_index = False
150
151# If true, links to the reST sources are added to the pages.
152#html_show_sourcelink = True
153
154# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
155#html_show_sphinx = True
156
157# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
158#html_show_copyright = True
159
160# If true, an OpenSearch description file will be output, and all pages will
161# contain a <link> tag referring to it.  The value of this option must be the
162# base URL from which the finished HTML is served.
163#html_use_opensearch = ''
164
165# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
166#html_file_suffix = ''
167
168# Output file base name for HTML help builder.
169htmlhelp_basename = 'pr_inversiondoc'
170
171
172# -- Options for LaTeX output --------------------------------------------------
173
174# The paper size ('letter' or 'a4').
175#latex_paper_size = 'letter'
176
177# The font size ('10pt', '11pt' or '12pt').
178#latex_font_size = '10pt'
179
180# Grouping the document tree into LaTeX files. List of tuples
181# (source start file, target name, title, author, documentclass [howto/manual]).
182latex_documents = [
183  ('index', 'pr_inversion.tex', u'pr\\_inversion Documentation',
184   u'sans group', 'manual'),
185]
186
187# The name of an image file (relative to this directory) to place at the top of
188# the title page.
189#latex_logo = None
190
191# For "manual" documents, if this is true, then toplevel headings are parts,
192# not chapters.
193#latex_use_parts = False
194
195# If true, show page references after internal links.
196#latex_show_pagerefs = False
197
198# If true, show URL addresses after external links.
199#latex_show_urls = False
200
201# Additional stuff for the LaTeX preamble.
202#latex_preamble = ''
203
204# Documents to append as an appendix to all manuals.
205#latex_appendices = []
206
207# If false, no module index is generated.
208#latex_domain_indices = True
209
210
211# -- Options for manual page output --------------------------------------------
212
213# One entry per manual page. List of tuples
214# (source start file, name, description, authors, manual section).
215man_pages = [
216    ('index', 'pr_inversion', u'pr_inversion Documentation',
217     [u'sans group'], 1)
218]
Note: See TracBrowser for help on using the repository browser.