source: PyFMI/branches/PyFMI-2.5.x/doc/sphinx/source/conf.py @ 13363

Last change on this file since 13363 was 13363, checked in by Christian Andersson, 3 months ago

Updated version number. Related to ticket:5826

File size: 9.1 KB
Line 
1# -*- coding: utf-8 -*-
2#
3# PyFMI documentation build configuration file, created by
4# sphinx-quickstart on Tue Jan 03 16:18:33 2012.
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#RUN MARKUP
17execfile("markup.py")
18
19# If extensions (or modules to document with autodoc) are in another directory,
20# add these directories to sys.path here. If the directory is relative to the
21# documentation root, use os.path.abspath to make it absolute, like shown here.
22#sys.path.insert(0, os.path.abspath('.'))
23
24# -- General configuration -----------------------------------------------------
25
26# If your documentation needs a minimal Sphinx version, state it here.
27#needs_sphinx = '1.0'
28
29# Add any Sphinx extension module names here, as strings. They can be extensions
30# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
31extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.viewcode']
32
33# Add any paths that contain templates here, relative to this directory.
34templates_path = ['_templates']
35
36# The suffix of source filenames.
37source_suffix = '.rst'
38
39# The encoding of source files.
40#source_encoding = 'utf-8-sig'
41
42# The master toctree document.
43master_doc = 'content'
44
45# General information about the project.
46project = u'PyFMI'
47copyright = u'2012, Modelon AB'
48
49# The version info for the project you're documenting, acts as replacement for
50# |version| and |release|, also used in various other places throughout the
51# built documents.
52#
53# The short X.Y version.
54version = '2.5.4'
55# The full version, including alpha/beta/rc tags.
56release = '2.5.4'
57
58# The language for content autogenerated by Sphinx. Refer to documentation
59# for a list of supported languages.
60#language = None
61
62# There are two options for replacing |today|: either, you set today to some
63# non-false value, then it is used:
64#today = ''
65# Else, today_fmt is used as the format for a strftime call.
66#today_fmt = '%B %d, %Y'
67
68# List of patterns, relative to source directory, that match files and
69# directories to ignore when looking for source files.
70exclude_patterns = []
71
72# The reST default role (used for this markup: `text`) to use for all documents.
73#default_role = None
74
75# If true, '()' will be appended to :func: etc. cross-reference text.
76#add_function_parentheses = True
77
78# If true, the current module name will be prepended to all description
79# unit titles (such as .. function::).
80#add_module_names = True
81
82# If true, sectionauthor and moduleauthor directives will be shown in the
83# output. They are ignored by default.
84#show_authors = False
85
86# The name of the Pygments (syntax highlighting) style to use.
87pygments_style = 'sphinx'
88
89# A list of ignored prefixes for module index sorting.
90#modindex_common_prefix = []
91
92
93# -- Options for HTML output ---------------------------------------------------
94
95# The theme to use for HTML and HTML Help pages.  See the documentation for
96# a list of builtin themes.
97html_theme = 'sphinxdoc'
98
99# Theme options are theme-specific and customize the look and feel of a theme
100# further.  For a list of options available for each theme, see the
101# documentation.
102#html_theme_options = {}
103html_theme_options = {
104    "nosidebar": "true"}
105
106# Add any paths that contain custom themes here, relative to this directory.
107#html_theme_path = []
108
109# The name for this set of Sphinx documents.  If None, it defaults to
110# "<project> v<release> documentation".
111html_title = "PyFMI 2.5.4 documentation"
112
113# A shorter title for the navigation bar.  Default is the same as html_title.
114#html_short_title = None
115
116# The name of an image file (relative to this directory) to place at the top
117# of the sidebar.
118#html_logo = None
119
120# The name of an image file (within the static path) to use as favicon of the
121# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
122# pixels large.
123#html_favicon = None
124
125# Add any paths that contain custom static files (such as style sheets) here,
126# relative to this directory. They are copied after the builtin static files,
127# so a file named "default.css" will overwrite the builtin "default.css".
128html_static_path = ['_static']
129
130# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
131# using the given strftime format.
132#html_last_updated_fmt = '%b %d, %Y'
133
134# If true, SmartyPants will be used to convert quotes and dashes to
135# typographically correct entities.
136#html_use_smartypants = True
137
138# Custom sidebar templates, maps document names to template names.
139#html_sidebars = {}
140
141# Additional templates that should be rendered to pages, maps page names to
142# template names.
143#html_additional_pages = {}
144html_additional_pages = {'index': 'index.html'}
145
146# If false, no module index is generated.
147#html_domain_indices = True
148
149# If false, no index is generated.
150#html_use_index = True
151
152# If true, the index is split into individual pages for each letter.
153#html_split_index = False
154
155# If true, links to the reST sources are added to the pages.
156#html_show_sourcelink = True
157
158# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
159#html_show_sphinx = True
160
161# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
162#html_show_copyright = True
163
164# If true, an OpenSearch description file will be output, and all pages will
165# contain a <link> tag referring to it.  The value of this option must be the
166# base URL from which the finished HTML is served.
167#html_use_opensearch = ''
168
169# This is the file name suffix for HTML files (e.g. ".xhtml").
170#html_file_suffix = None
171
172# Output file base name for HTML help builder.
173htmlhelp_basename = 'PyFMIdoc'
174
175
176# -- Options for LaTeX output --------------------------------------------------
177
178latex_elements = {
179# The paper size ('letterpaper' or 'a4paper').
180#'papersize': 'letterpaper',
181
182# The font size ('10pt', '11pt' or '12pt').
183#'pointsize': '10pt',
184
185# Additional stuff for the LaTeX preamble.
186#'preamble': '',
187}
188
189# Grouping the document tree into LaTeX files. List of tuples
190# (source start file, target name, title, author, documentclass [howto/manual]).
191latex_documents = [
192  ('content', 'PyFMI.tex', u'PyFMI Documentation',
193   u'Modelon AB', 'manual'),
194]
195
196# The name of an image file (relative to this directory) to place at the top of
197# the title page.
198#latex_logo = None
199
200# For "manual" documents, if this is true, then toplevel headings are parts,
201# not chapters.
202#latex_use_parts = False
203
204# If true, show page references after internal links.
205#latex_show_pagerefs = False
206
207# If true, show URL addresses after external links.
208#latex_show_urls = False
209
210# Documents to append as an appendix to all manuals.
211#latex_appendices = []
212
213# If false, no module index is generated.
214#latex_domain_indices = True
215
216
217# -- Options for manual page output --------------------------------------------
218
219# One entry per manual page. List of tuples
220# (source start file, name, description, authors, manual section).
221man_pages = [
222    ('content', 'pyfmi', u'PyFMI Documentation',
223     [u'Modelon AB'], 1)
224]
225
226# If true, show URL addresses after external links.
227#man_show_urls = False
228
229
230# -- Options for Texinfo output ------------------------------------------------
231
232# Grouping the document tree into Texinfo files. List of tuples
233# (source start file, target name, title, author,
234#  dir menu entry, description, category)
235texinfo_documents = [
236  ('content', 'PyFMI', u'PyFMI Documentation',
237   u'Modelon AB', 'PyFMI', 'Working with FMI from Python.',
238   'Miscellaneous'),
239]
240
241# Documents to append as an appendix to all manuals.
242#texinfo_appendices = []
243
244# If false, no module index is generated.
245#texinfo_domain_indices = True
246
247# How to display URL addresses: 'footnote', 'no', or 'inline'.
248#texinfo_show_urls = 'footnote'
249
250
251# -- Options for Epub output ---------------------------------------------------
252
253# Bibliographic Dublin Core info.
254epub_title = u'PyFMI'
255epub_author = u'Modelon AB'
256epub_publisher = u'Modelon AB'
257epub_copyright = u'2012, Modelon AB'
258
259# The language of the text. It defaults to the language option
260# or en if the language is not set.
261#epub_language = ''
262
263# The scheme of the identifier. Typical schemes are ISBN or URL.
264#epub_scheme = ''
265
266# The unique identifier of the text. This can be a ISBN number
267# or the project homepage.
268#epub_identifier = ''
269
270# A unique identification for the text.
271#epub_uid = ''
272
273# A tuple containing the cover image and cover page html template filenames.
274#epub_cover = ()
275
276# HTML files that should be inserted before the pages created by sphinx.
277# The format is a list of tuples containing the path and title.
278#epub_pre_files = []
279
280# HTML files shat should be inserted after the pages created by sphinx.
281# The format is a list of tuples containing the path and title.
282#epub_post_files = []
283
284# A list of files that should not be packed into the epub file.
285#epub_exclude_files = []
286
287# The depth of the table of contents in toc.ncx.
288#epub_tocdepth = 3
289
290# Allow duplicate toc entries.
291#epub_tocdup = True
292
293
294# Example configuration for intersphinx: refer to the Python standard library.
295intersphinx_mapping = {'http://docs.python.org/': None}
Note: See TracBrowser for help on using the repository browser.