source: trunk/docs/conf.py @ 119

Last change on this file since 119 was 119, checked in by anonymous, 13 years ago

add default sphinx template

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, Jeff McKenna, Gerald Fenoy, Nicolas Bozon'
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.0'
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.
99#html_theme_options = {
100#     "rightsidebar": "true"
101#    "headbgcolor": "#ffffff",
102#    "bgcolor": "#ffffff",
103#    "textcolor": "#646464",
104#    "linkcolor": "#fc9326",
105#    "visitedlinkcolor": "#fc9326",   
106#    "sidebarbgcolor": "red",
107#    "relbarbgcolor": "#5e3905"   
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".
115#html_title = None
116
117# A shorter title for the navigation bar.  Default is the same as html_title.
118#html_short_title = None
119
120# The name of an image file (relative to this directory) to place at the top
121# of the sidebar.
122#html_logo = None
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.
127#html_favicon = None
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.
143#html_sidebars = {}
144
145# Additional templates that should be rendered to pages, maps page names to
146# template names.
147#html_additional_pages = {}
148
149# If false, no module index is generated.
150#html_domain_indices = True
151
152# If false, no index is generated.
153#html_use_index = True
154
155# If true, the index is split into individual pages for each letter.
156#html_split_index = False
157
158# If true, links to the reST sources are added to the pages.
159#html_show_sourcelink = True
160
161# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
162#html_show_sphinx = True
163
164# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
165#html_show_copyright = True
166
167# If true, an OpenSearch description file will be output, and all pages will
168# contain a <link> tag referring to it.  The value of this option must be the
169# base URL from which the finished HTML is served.
170#html_use_opensearch = ''
171
172# This is the file name suffix for HTML files (e.g. ".xhtml").
173#html_file_suffix = None
174
175# Output file base name for HTML help builder.
176htmlhelp_basename = 'ZOOProjectdoc'
177
178
179# -- Options for LaTeX output --------------------------------------------------
180
181# The paper size ('letter' or 'a4').
182#latex_paper_size = 'letter'
183
184# The font size ('10pt', '11pt' or '12pt').
185#latex_font_size = '10pt'
186
187# Grouping the document tree into LaTeX files. List of tuples
188# (source start file, target name, title, author, documentclass [howto/manual]).
189latex_documents = [
190  ('index', 'ZOOProject.tex', u'ZOO Project Documentation',
191   u'Jeff McKenna, Gerald Fenoy, Nicolas Bozon', 'manual'),
192]
193
194# The name of an image file (relative to this directory) to place at the top of
195# the title page.
196#latex_logo = None
197
198# For "manual" documents, if this is true, then toplevel headings are parts,
199# not chapters.
200#latex_use_parts = False
201
202# If true, show page references after internal links.
203#latex_show_pagerefs = False
204
205# If true, show URL addresses after external links.
206#latex_show_urls = False
207
208# Additional stuff for the LaTeX preamble.
209#latex_preamble = ''
210
211# Documents to append as an appendix to all manuals.
212#latex_appendices = []
213
214# If false, no module index is generated.
215#latex_domain_indices = True
216
217
218# -- Options for manual page output --------------------------------------------
219
220# One entry per manual page. List of tuples
221# (source start file, name, description, authors, manual section).
222man_pages = [
223    ('index', 'zooproject', u'ZOO Project Documentation',
224     [u'Jeff McKenna, Gerald Fenoy, Nicolas Bozon'], 1)
225]
226
227
228# -- Options for Epub output ---------------------------------------------------
229
230# Bibliographic Dublin Core info.
231epub_title = u'ZOO Project'
232epub_author = u'Jeff McKenna, Gerald Fenoy, Nicolas Bozon'
233epub_publisher = u'Jeff McKenna, Gerald Fenoy, Nicolas Bozon'
234epub_copyright = u'2011, Jeff McKenna, Gerald Fenoy, Nicolas Bozon'
235
236# The language of the text. It defaults to the language option
237# or en if the language is not set.
238#epub_language = ''
239
240# The scheme of the identifier. Typical schemes are ISBN or URL.
241#epub_scheme = ''
242
243# The unique identifier of the text. This can be a ISBN number
244# or the project homepage.
245#epub_identifier = ''
246
247# A unique identification for the text.
248#epub_uid = ''
249
250# HTML files that should be inserted before the pages created by sphinx.
251# The format is a list of tuples containing the path and title.
252#epub_pre_files = []
253
254# HTML files shat should be inserted after the pages created by sphinx.
255# The format is a list of tuples containing the path and title.
256#epub_post_files = []
257
258# A list of files that should not be packed into the epub file.
259#epub_exclude_files = []
260
261# The depth of the table of contents in toc.ncx.
262#epub_tocdepth = 3
263
264# Allow duplicate toc entries.
265#epub_tocdup = True
Note: See TracBrowser for help on using the repository browser.

Search

Context Navigation

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