source: main/waeup.kofa/trunk/docs/source/conf.py @ 11133

Last change on this file since 11133 was 8438, checked in by Henrik Bettermann, 12 years ago

Add instruction regarding beaker. 13 steps to get Kofa running on Windows, that's a long way.

  • Property svn:keywords set to Id
File size: 7.0 KB
Line 
1# -*- coding: utf-8 -*-
2#
3# WAeUP Student Information and Registration Portal (Kofa) documentation build configuration file, created by
4# sphinx-quickstart on Thu Jul 29 10:41:59 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
15import pkg_resources
16
17# If extensions (or modules to document with autodoc) are in another directory,
18# add these directories to sys.path here. If the directory is relative to the
19# documentation root, use os.path.abspath to make it absolute, like shown here.
20#sys.path.append(os.path.abspath('.'))
21
22# -- General configuration -----------------------------------------------------
23
24# Add any Sphinx extension module names here, as strings. They can be extensions
25# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
26extensions = [
27    'sphinx.ext.autodoc',
28    'sphinx.ext.doctest',
29    'sphinx.ext.intersphinx',
30    'sphinx.ext.todo',
31    'sphinx.ext.coverage',
32    'sphinx.ext.ifconfig',
33    'sphinx.ext.viewcode',
34    'repoze.sphinx.autointerface'
35    ]
36
37# Add any paths that contain templates here, relative to this directory.
38templates_path = ['_templates']
39
40# The suffix of source filenames.
41source_suffix = '.rst'
42
43# The encoding of source files.
44#source_encoding = 'utf-8'
45
46# The master toctree document.
47master_doc = 'index'
48
49# General information about the project.
50project = u'WAeUP.Kofa'
51copyright = u'2011, WAeUP Team'
52
53# The version info for the project you're documenting, acts as replacement for
54# |version| and |release|, also used in various other places throughout the
55# built documents.
56#
57# The short X.Y version.
58version = pkg_resources.get_distribution('waeup.kofa').version
59#version = '0.2dev'
60# The full version, including alpha/beta/rc tags.
61#release = '0.2dev'
62release = version
63
64# The language for content autogenerated by Sphinx. Refer to documentation
65# for a list of supported languages.
66#language = None
67
68# There are two options for replacing |today|: either, you set today to some
69# non-false value, then it is used:
70#today = ''
71# Else, today_fmt is used as the format for a strftime call.
72#today_fmt = '%B %d, %Y'
73
74# List of documents that shouldn't be included in the build.
75#unused_docs = []
76
77# List of directories, relative to source directory, that shouldn't be searched
78# for source files.
79exclude_trees = []
80
81# The reST default role (used for this markup: `text`) to use for all documents.
82#default_role = None
83
84# If true, '()' will be appended to :func: etc. cross-reference text.
85#add_function_parentheses = True
86
87# If true, the current module name will be prepended to all description
88# unit titles (such as .. function::).
89#add_module_names = True
90
91# If true, sectionauthor and moduleauthor directives will be shown in the
92# output. They are ignored by default.
93#show_authors = False
94
95# The name of the Pygments (syntax highlighting) style to use.
96pygments_style = 'sphinx'
97
98# A list of ignored prefixes for module index sorting.
99#modindex_common_prefix = []
100
101
102# -- Options for HTML output ---------------------------------------------------
103
104# The theme to use for HTML and HTML Help pages.  Major themes that come with
105# Sphinx are currently 'default' and 'sphinxdoc'.
106html_theme = 'default'
107
108# Theme options are theme-specific and customize the look and feel of a theme
109# further.  For a list of options available for each theme, see the
110# documentation.
111#html_theme_options = {}
112
113# Add any paths that contain custom themes here, relative to this directory.
114#html_theme_path = []
115
116# The name for this set of Sphinx documents.  If None, it defaults to
117# "<project> v<release> documentation".
118#html_title = None
119
120# A shorter title for the navigation bar.  Default is the same as html_title.
121#html_short_title = None
122
123# The name of an image file (relative to this directory) to place at the top
124# of the sidebar.
125#html_logo = None
126
127# The name of an image file (within the static path) to use as favicon of the
128# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
129# pixels large.
130#html_favicon = None
131html_favicon = "favicon.ico"
132
133# Add any paths that contain custom static files (such as style sheets) here,
134# relative to this directory. They are copied after the builtin static files,
135# so a file named "default.css" will overwrite the builtin "default.css".
136html_static_path = ['_static']
137
138# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
139# using the given strftime format.
140#html_last_updated_fmt = '%b %d, %Y'
141
142# If true, SmartyPants will be used to convert quotes and dashes to
143# typographically correct entities.
144#html_use_smartypants = True
145
146# Custom sidebar templates, maps document names to template names.
147#html_sidebars = {}
148
149# Additional templates that should be rendered to pages, maps page names to
150# template names.
151#html_additional_pages = {}
152#html_additional_pages = {
153#    'index': os.path.join(os.path.dirname(__file__), 'docindex.template')}
154html_additional_pages = { 'index': 'mainpage.template'}
155# If false, no module index is generated.
156#html_use_modindex = True
157
158# If false, no index is generated.
159#html_use_index = True
160
161# If true, the index is split into individual pages for each letter.
162#html_split_index = False
163
164# If true, links to the reST sources are added to the pages.
165#html_show_sourcelink = 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# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
173#html_file_suffix = ''
174
175# Output file base name for HTML help builder.
176htmlhelp_basename = 'WAeUPStudentInformationandRegistrationPortalKofadoc'
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', 'WAeUPStudentInformationandRegistrationPortalKofa.tex', u'WAeUP Student Information and Registration Portal (Kofa) Documentation',
191   u'WAeUP Team', '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# Additional stuff for the LaTeX preamble.
203#latex_preamble = ''
204
205# Documents to append as an appendix to all manuals.
206#latex_appendices = []
207
208# If false, no module index is generated.
209#latex_use_modindex = True
210
211
212# Example configuration for intersphinx: refer to the Python standard library.
213intersphinx_mapping = {'http://docs.python.org/': None}
Note: See TracBrowser for help on using the repository browser.