Premiere version : mise en route du suivi.
[auf_roundup.git] / doc / .svn / text-base / conf.py.svn-base
1 # -*- coding: utf-8 -*-
2 #
3 # Roundup documentation build configuration file, created by
4 # sphinx-quickstart on Tue Jan 20 17:33:20 2009.
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
8 # The contents of this file are pickled, so don't put values in the namespace
9 # that aren't pickleable (module imports are okay, they're removed automatically).
10 #
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
13
14 import sys, os
15
16 # If your extensions are in another directory, add it here. If the directory
17 # is relative to the documentation root, use os.path.abspath to make it
18 # absolute, like shown here.
19 #sys.path.append(os.path.abspath('.'))
20
21 # General configuration
22 # ---------------------
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.
26 #extensions = ['toctree']
27
28 # Add any paths that contain templates here, relative to this directory.
29 templates_path = ['_templates']
30
31 # The suffix of source filenames.
32 source_suffix = '.txt'
33
34 # The encoding of source files.
35 #source_encoding = 'utf-8'
36
37 # The master toctree document.
38 master_doc = 'index'
39
40 # General information about the project.
41 project = u'Roundup'
42 copyright = u'2009, Richard Jones'
43
44 # The version info for the project you're documenting, acts as replacement for
45 # |version| and |release|, also used in various other places throughout the
46 # built documents.
47 #
48 # The short X.Y version.
49 version = '1.4'
50 # The full version, including alpha/beta/rc tags.
51 release = '1.4'
52
53 # The language for content autogenerated by Sphinx. Refer to documentation
54 # for a list of supported languages.
55 #language = None
56
57 # There are two options for replacing |today|: either, you set today to some
58 # non-false value, then it is used:
59 #today = ''
60 # Else, today_fmt is used as the format for a strftime call.
61 #today_fmt = '%B %d, %Y'
62
63 # List of documents that shouldn't be included in the build.
64 #unused_docs = []
65
66 # List of directories, relative to source directory, that shouldn't be searched
67 # for source files.
68 exclude_trees = ['.build']
69
70 # The reST default role (used for this markup: `text`) to use for all documents.
71 #default_role = None
72
73 # If true, '()' will be appended to :func: etc. cross-reference text.
74 #add_function_parentheses = True
75
76 # If true, the current module name will be prepended to all description
77 # unit titles (such as .. function::).
78 #add_module_names = True
79
80 # If true, sectionauthor and moduleauthor directives will be shown in the
81 # output. They are ignored by default.
82 #show_authors = False
83
84 # The name of the Pygments (syntax highlighting) style to use.
85 pygments_style = 'sphinx'
86
87
88 # Options for HTML output
89 # -----------------------
90
91 # The style sheet to use for HTML and HTML Help pages. A file of that name
92 # must exist either in Sphinx' static/ path, or in one of the custom paths
93 # given in html_static_path.
94 html_style = 'default.css'
95
96 # The name for this set of Sphinx documents.  If None, it defaults to
97 # "<project> v<release> documentation".
98 #html_title = None
99
100 # A shorter title for the navigation bar.  Default is the same as html_title.
101 #html_short_title = None
102
103 # The name of an image file (relative to this directory) to place at the top
104 # of the sidebar.
105 #html_logo = None
106
107 # The name of an image file (within the static path) to use as favicon of the
108 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
109 # pixels large.
110 #html_favicon = None
111
112 # Add any paths that contain custom static files (such as style sheets) here,
113 # relative to this directory. They are copied after the builtin static files,
114 # so a file named "default.css" will overwrite the builtin "default.css".
115 html_static_path = ['_static']
116
117 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
118 # using the given strftime format.
119 html_last_updated_fmt = '%b %d, %Y'
120
121 # If true, SmartyPants will be used to convert quotes and dashes to
122 # typographically correct entities.
123 #html_use_smartypants = True
124
125 # Custom sidebar templates, maps document names to template names.
126 #html_sidebars = {}
127
128 html_collapse_toctree = True
129
130 # Additional templates that should be rendered to pages, maps page names to
131 # template names.
132 #html_additional_pages = {}
133
134 html_add_permalinks = False
135
136 # If false, no module index is generated.
137 #html_use_modindex = True
138
139 # If false, no index is generated.
140 #html_use_index = True
141
142 # If true, the index is split into individual pages for each letter.
143 #html_split_index = False
144
145 # If true, the reST sources are included in the HTML build as _sources/<name>.
146 #html_copy_source = True
147
148 # If true, an OpenSearch description file will be output, and all pages will
149 # contain a <link> tag referring to it.  The value of this option must be the
150 # base URL from which the finished HTML is served.
151 #html_use_opensearch = ''
152
153 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
154 #html_file_suffix = ''
155
156 # Output file base name for HTML help builder.
157 htmlhelp_basename = 'Roundupdoc'
158
159
160 # Options for LaTeX output
161 # ------------------------
162
163 # The paper size ('letter' or 'a4').
164 #latex_paper_size = 'letter'
165
166 # The font size ('10pt', '11pt' or '12pt').
167 #latex_font_size = '10pt'
168
169 # Grouping the document tree into LaTeX files. List of tuples
170 # (source start file, target name, title, author, document class [howto/manual]).
171 latex_documents = [
172   ('docs/index', 'Roundup.tex', u'Roundup Documentation',
173    u'Richard Jones', 'manual'),
174 ]
175
176 # The name of an image file (relative to this directory) to place at the top of
177 # the title page.
178 #latex_logo = None
179
180 # For "manual" documents, if this is true, then toplevel headings are parts,
181 # not chapters.
182 #latex_use_parts = False
183
184 # Additional stuff for the LaTeX preamble.
185 #latex_preamble = ''
186
187 # Documents to append as an appendix to all manuals.
188 #latex_appendices = []
189
190 # If false, no module index is generated.
191 #latex_use_modindex = True