source: trunk/docs/conf.py @ 348

Last change on this file since 348 was 348, checked in by neteler, 8 years ago

set correctly svn propset

  • Property svn:eol-style set to native
  • Property svn:mime-type set to text/x-python
File size: 8.7 KB
Line 
1# -*- coding: utf-8 -*-
2#
3# ZOO Project documentation build configuration file, created by
4# sphinx-quickstart on Tue Mar 08 12:11:20 2011.
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.insert(0, os.path.abspath('.'))
20
21# -- General configuration -----------------------------------------------------
22
23# If your documentation needs a minimal Sphinx version, state it here.
24#needs_sphinx = '1.0'
25
26# Add any Sphinx extension module names here, as strings. They can be extensions
27# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode']
29
30# Add any paths that contain templates here, relative to this directory.
31templates_path = ['_templates']
32
33# The suffix of source filenames.
34source_suffix = '.txt'
35
36# The encoding of source files.
37#source_encoding = 'utf-8-sig'
38
39# The master toctree document.
40master_doc = 'index'
41
42# General information about the project.
43project = u'ZOO Project'
44copyright = u'2011, Nicolas Bozon, Gérald Fenoy, Jeff McKenna'
45
46# The version info for the project you're documenting, acts as replacement for
47# |version| and |release|, also used in various other places throughout the
48# built documents.
49#
50# The short X.Y version.
51version = '1.0'
52# The full version, including alpha/beta/rc tags.
53release = '1.2'
54
55# The language for content autogenerated by Sphinx. Refer to documentation
56# for a list of supported languages.
57#language = None
58
59# There are two options for replacing |today|: either, you set today to some
60# non-false value, then it is used:
61#today = ''
62# Else, today_fmt is used as the format for a strftime call.
63#today_fmt = '%B %d, %Y'
64
65# List of patterns, relative to source directory, that match files and
66# directories to ignore when looking for source files.
67exclude_patterns = ['_build']
68
69# The reST default role (used for this markup: `text`) to use for all documents.
70#default_role = None
71
72# If true, '()' will be appended to :func: etc. cross-reference text.
73#add_function_parentheses = True
74
75# If true, the current module name will be prepended to all description
76# unit titles (such as .. function::).
77#add_module_names = True
78
79# If true, sectionauthor and moduleauthor directives will be shown in the
80# output. They are ignored by default.
81#show_authors = False
82
83# The name of the Pygments (syntax highlighting) style to use.
84pygments_style = 'sphinx'
85
86# A list of ignored prefixes for module index sorting.
87#modindex_common_prefix = []
88
89
90# -- Options for HTML output ---------------------------------------------------
91
92# The theme to use for HTML and HTML Help pages.  See the documentation for
93# a list of builtin themes.
94html_theme = 'default'
95
96# Theme options are theme-specific and customize the look and feel of a theme
97# further.  For a list of options available for each theme, see the
98# documentation.
99html_theme_options = {
100    "rightsidebar": "true",
101    "headbgcolor": "#ffffff",
102    "bgcolor": "#ffffff",
103    "textcolor": "#333333",
104    "linkcolor": "#fc9326",
105    "visitedlinkcolor": "#fc9326",   
106    "sidebarbgcolor": "white",
107    "relbarbgcolor": "#ffa500"   
108}
109
110# Add any paths that contain custom themes here, relative to this directory.
111#html_theme_path = []
112
113# The name for this set of Sphinx documents.  If None, it defaults to
114# "<project> v<release> documentation".
115html_title = "ZOO Project " + release + " documentation"
116
117# A shorter title for the navigation bar.  Default is the same as html_title.
118html_short_title = "ZOO Docs"
119
120# The name of an image file (relative to this directory) to place at the top
121# of the sidebar.
122#html_logo =
123
124# The name of an image file (within the static path) to use as favicon of the
125# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
126# pixels large.
127html_favicon = "favicon.ico"
128
129# Add any paths that contain custom static files (such as style sheets) here,
130# relative to this directory. They are copied after the builtin static files,
131# so a file named "default.css" will overwrite the builtin "default.css".
132html_static_path = ['_static']
133
134# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
135# using the given strftime format.
136#html_last_updated_fmt = '%b %d, %Y'
137
138# If true, SmartyPants will be used to convert quotes and dashes to
139# typographically correct entities.
140#html_use_smartypants = True
141
142# Custom sidebar templates, maps document names to template names.
143html_sidebars = {
144'**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'],
145"index":["indexsidebar.html",'searchbox.html']}
146
147# Additional templates that should be rendered to pages, maps page names to
148# template names.
149#html_additional_pages = {}
150
151# If false, no module index is generated.
152#html_domain_indices = True
153
154# If false, no index is generated.
155#html_use_index = True
156
157# If true, the index is split into individual pages for each letter.
158#html_split_index = False
159
160# If true, links to the reST sources are added to the pages.
161html_show_sourcelink = False
162
163# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
164html_show_sphinx = False
165
166# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
167html_show_copyright = False
168
169# If true, an OpenSearch description file will be output, and all pages will
170# contain a <link> tag referring to it.  The value of this option must be the
171# base URL from which the finished HTML is served.
172#html_use_opensearch = ''
173
174# This is the file name suffix for HTML files (e.g. ".xhtml").
175#html_file_suffix = None
176
177# Output file base name for HTML help builder.
178htmlhelp_basename = 'ZOOProjectdoc'
179
180
181# -- Options for LaTeX output --------------------------------------------------
182
183# The paper size ('letter' or 'a4').
184#latex_paper_size = 'letter'
185
186# The font size ('10pt', '11pt' or '12pt').
187#latex_font_size = '10pt'
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  ('index', 'ZOOProject.tex', u'ZOO Project Documentation',
193   u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna', 'manual'),
194]
195
196# The name of an image file (relative to this directory) to place at the top of
197# the title page.
198latex_logo = './_static/images/zoo-banner-large.png'
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# Additional stuff for the LaTeX preamble.
211latex_preamble = '\setcounter{tocdepth}{3}'
212
213# Documents to append as an appendix to all manuals.
214#latex_appendices = []
215
216# If false, no module index is generated.
217#latex_domain_indices = True
218
219
220# -- Options for manual page output --------------------------------------------
221
222# One entry per manual page. List of tuples
223# (source start file, name, description, authors, manual section).
224man_pages = [
225    ('index', 'zooproject', u'ZOO Project Documentation',
226     [u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna'], 1)
227]
228
229
230# -- Options for Epub output ---------------------------------------------------
231
232# Bibliographic Dublin Core info.
233epub_title = u'ZOO Project'
234epub_author = u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna'
235epub_publisher = u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna'
236epub_copyright = u'2011, Nicolas Bozon, Gérald Fenoy, Jeff McKenna'
237
238# The language of the text. It defaults to the language option
239# or en if the language is not set.
240#epub_language = ''
241
242# The scheme of the identifier. Typical schemes are ISBN or URL.
243epub_scheme = 'URL'
244
245# The unique identifier of the text. This can be a ISBN number
246# or the project homepage.
247epub_identifier = 'http://zoo-project.org'
248
249# A unique identification for the text.
250#epub_uid = ''
251
252# HTML files that should be inserted before the pages created by sphinx.
253# The format is a list of tuples containing the path and title.
254#epub_pre_files = []
255
256# HTML files shat should be inserted after the pages created by sphinx.
257# The format is a list of tuples containing the path and title.
258#epub_post_files = []
259
260# A list of files that should not be packed into the epub file.
261#epub_exclude_files = []
262
263# The depth of the table of contents in toc.ncx.
264#epub_tocdepth = 3
265
266# Allow duplicate toc entries.
267#epub_tocdup = True
Note: See TracBrowser for help on using the repository browser.

Search

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png