1 # -*- coding: utf-8 -*-
3 # Indico documentation build configuration file, created by
4 # sphinx-quickstart on Mon Jan 18 17:19:35 2010.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
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.append(os.path.abspath('.'))
21 # -- General configuration -----------------------------------------------------
23 # Add any Sphinx extension module names here, as strings. They can be extensions
24 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
27 # Add any paths that contain templates here, relative to this directory.
28 templates_path
= ['_templates']
30 # The suffix of source filenames.
31 source_suffix
= '.rst'
33 # The encoding of source files.
34 #source_encoding = 'utf-8'
36 # The master toctree document.
39 # General information about the project.
41 copyright
= u
'2010, Indico Team'
43 # The version info for the project you're documenting, acts as replacement for
44 # |version| and |release|, also used in various other places throughout the
47 # The short X.Y version.
49 # The full version, including alpha/beta/rc tags.
52 # The language for content autogenerated by Sphinx. Refer to documentation
53 # for a list of supported languages.
56 # There are two options for replacing |today|: either, you set today to some
57 # non-false value, then it is used:
59 # Else, today_fmt is used as the format for a strftime call.
60 #today_fmt = '%B %d, %Y'
62 # List of documents that shouldn't be included in the build.
65 # List of directories, relative to source directory, that shouldn't be searched
67 exclude_trees
= ['_build']
69 # The reST default role (used for this markup: `text`) to use for all documents.
72 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #add_module_names = True
79 # If true, sectionauthor and moduleauthor directives will be shown in the
80 # output. They are ignored by default.
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style
= 'sphinx'
86 # A list of ignored prefixes for module index sorting.
87 #modindex_common_prefix = []
90 # -- Options for HTML output ---------------------------------------------------
92 # The theme to use for HTML and HTML Help pages. Major themes that come with
93 # Sphinx are currently 'default' and 'sphinxdoc'.
94 html_theme
= 'default'
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
99 #html_theme_options = {}
101 # Add any paths that contain custom themes here, relative to this directory.
102 #html_theme_path = []
104 # The name for this set of Sphinx documents. If None, it defaults to
105 # "<project> v<release> documentation".
108 # A shorter title for the navigation bar. Default is the same as html_title.
109 #html_short_title = None
111 # The name of an image file (relative to this directory) to place at the top
115 # The name of an image file (within the static path) to use as favicon of the
116 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
120 # Add any paths that contain custom static files (such as style sheets) here,
121 # relative to this directory. They are copied after the builtin static files,
122 # so a file named "default.css" will overwrite the builtin "default.css".
123 html_static_path
= ['_static']
125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
126 # using the given strftime format.
127 #html_last_updated_fmt = '%b %d, %Y'
129 # If true, SmartyPants will be used to convert quotes and dashes to
130 # typographically correct entities.
131 #html_use_smartypants = True
133 # Custom sidebar templates, maps document names to template names.
136 # Additional templates that should be rendered to pages, maps page names to
138 #html_additional_pages = {}
140 # If false, no module index is generated.
141 #html_use_modindex = True
143 # If false, no index is generated.
144 #html_use_index = True
146 # If true, the index is split into individual pages for each letter.
147 #html_split_index = False
149 # If true, links to the reST sources are added to the pages.
150 html_show_sourcelink
= False
152 # If true, an OpenSearch description file will be output, and all pages will
153 # contain a <link> tag referring to it. The value of this option must be the
154 # base URL from which the finished HTML is served.
155 #html_use_opensearch = ''
157 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
158 #html_file_suffix = ''
160 # Output file base name for HTML help builder.
161 htmlhelp_basename
= 'Indicodoc'
164 # -- Options for LaTeX output --------------------------------------------------
166 latex_elements
= { "inputenc": "\\usepackage[utf8]{inputenc}",
167 "papersize": "a4paper"
170 # The paper size ('letter' or 'a4').
171 #latex_paper_size = 'letter'
173 # The font size ('10pt', '11pt' or '12pt').
174 #latex_font_size = '10pt'
176 # Grouping the document tree into LaTeX files. List of tuples
177 # (source start file, target name, title, author, documentclass [howto/manual]).
179 ('UserGuide/index', 'IndicoUserGuide.tex', u
'Indico User Guide',
180 u
'Indico Team', 'manual'),
181 ('VideoServicesGuides/AdminGuide/index', 'IndicoVSAdminGuide.tex', u
'VS Admin Documentation',
182 u
'Indico Team', 'manual'),
183 ('VideoServicesGuides/ManagerOverview/index', 'IndicoVSManagerOverview.tex', u
'Indico Documentation',
184 u
'Indico Team', 'manual'),
185 ('VideoServicesGuides/EventManager/index', 'IndicoVSEventManager.tex', u
'Indico Documentation',
186 u
'Indico Team', 'manual'),
187 ('VideoServicesGuides/UserGuide/index', 'IndicoVSUserGuide.tex', u
'Indico Documentation',
188 u
'Indico Team', 'manual'),
189 ('Chat/ChatUserGuide', 'IndicoChatUserGuide.tex', u
'Indico Documentation',
190 u
'Indico Team', 'manual'),
191 ('Chat/XMPPClients', 'IndicoChatXMPPClients.tex', u
'Indico Documentation',
192 u
'Indico Team', 'manual'),
193 ('Importer/Importer', 'IndicoImporter.tex', u
'Indico Documentation',
194 u
'Indico Team', 'manual'),
195 ('QuickStartGuides/QSGAgendaUsers/index', 'IndicoQSGAgendaUsers.tex', u
'Indico Documentation',
196 u
'Indico Team', 'manual'),
197 ('QuickStartGuides/QSGContributionManager/index', 'IndicoQSGContributionManager.tex', u
'Indico Documentation',
198 u
'Indico Team', 'manual'),
199 ('QuickStartGuides/QSGSessionCoordinator/index', 'IndicoQSGSessionCoordinator.tex', u
'Indico Documentation',
200 u
'Indico Team', 'manual'),
201 ('QuickStartGuides/QSGSessionManager/index', 'IndicoQSGSessionManager.tex', u
'Indico Documentation',
202 u
'Indico Team', 'manual'),
203 ('QuickStartGuides/QSGSubmitter/index', 'IndicoQSGSubmitter.tex', u
'Indico Documentation',
204 u
'Indico Team', 'manual'),
205 ('QuickStartGuides/QSGTrackCoordinator/index', 'IndicoQSGTrackCoordinator.tex', u
'Indico Documentation',
206 u
'Indico Team', 'manual'),
207 ('AdminGuide/index', 'IndicoAdminGuide.tex', u
'Indico Documentation',
208 u
'Indico Team', 'manual'),
209 ('FAQ/FAQ', 'IndicoFAQ.tex', u
'Indico Documentation',
210 u
'Indico Team', 'manual'),
211 ('Glossary/Glossary', 'IndicoGlossary.tex', u
'Indico Documentation',
212 u
'Indico Team', 'manual'),
213 ('PaperReviewingGuides/PaperReviewingEditors/index', 'IndicoLayoutReviewer.tex', u
'Paper Reviewing User Guide',
214 u
'Indico Team', 'manual'),
215 ('PaperReviewingGuides/PaperReviewingManagers/index', 'IndicoReviewingManager.tex', u
'Paper Reviewing User Guide',
216 u
'Indico Team', 'manual'),
217 ('PaperReviewingGuides/PaperReviewingReferees/index', 'IndicoReferee.tex', u
'Paper Reviewing User Guide',
218 u
'Indico Team', 'manual'),
219 ('PaperReviewingGuides/PaperReviewingReviewers/index', 'IndicoContentReviewer.tex', u
'Paper Reviewing User Guide',
220 u
'Indico Team', 'manual'),
221 ('PaperReviewingGuides/PaperReviewingRoles/index', 'IndicoReviewingRole.tex', u
'Paper Reviewing User Guide',
222 u
'Indico Team', 'manual'),
223 ('PaperReviewingGuides/PaperReviewingAuthors/index', 'IndicoReviewingAuthors.tex', u
'Paper Reviewing User Guide',
224 u
'Indico Team', 'manual'),
227 # The name of an image file (relative to this directory) to place at the top of
231 # For "manual" documents, if this is true, then toplevel headings are parts,
233 #latex_use_parts = False
235 # Additional stuff for the LaTeX preamble.
238 # Documents to append as an appendix to all manuals.
239 #latex_appendices = []
241 # If false, no module index is generated.
242 #latex_use_modindex = True