ne pas inclure /docs/_build
[auf-django-sdk.git] / docs / conf.py
CommitLineData
9bffaf95
PH
1# -*- coding: utf-8 -*-
2import sphinx_rtd_theme
3#
4# auf-django-sdk documentation build configuration file, created by
5# sphinx-quickstart on Tue Nov 25 10:16:54 2014.
6#
7# This file is execfile()d with the current directory set to its
8# containing dir.
9#
10# Note that not all possible configuration values are present in this
11# autogenerated file.
12#
13# All configuration values have a default; values that are commented out
14# serve to show the default.
15
16import sys
17import os
18
19# If extensions (or modules to document with autodoc) are in another directory,
20# add these directories to sys.path here. If the directory is relative to the
21# documentation root, use os.path.abspath to make it absolute, like shown here.
22#sys.path.insert(0, os.path.abspath('.'))
23
24# -- General configuration ------------------------------------------------
25
26# If your documentation needs a minimal Sphinx version, state it here.
27#needs_sphinx = '1.0'
28
29# Add any Sphinx extension module names here, as strings. They can be
30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31# ones.
32extensions = []
33
34# Add any paths that contain templates here, relative to this directory.
35templates_path = ['_templates']
36
37# The suffix of source filenames.
38source_suffix = '.rst'
39
40# The encoding of source files.
41#source_encoding = 'utf-8-sig'
42
43# The master toctree document.
44master_doc = 'index'
45
46# General information about the project.
47project = u'auf-django-sdk'
48copyright = u'2015, \xa9 Agence universitaire de la Francophonie'
49
50# The version info for the project you're documenting, acts as replacement for
51# |version| and |release|, also used in various other places throughout the
52# built documents.
53#
54# The short X.Y version.
55version = '0.1'
56# The full version, including alpha/beta/rc tags.
57release = '0.1'
58
59# The language for content autogenerated by Sphinx. Refer to documentation
60# for a list of supported languages.
61language = "french"
62
63# There are two options for replacing |today|: either, you set today to some
64# non-false value, then it is used:
65#today = ''
66# Else, today_fmt is used as the format for a strftime call.
67#today_fmt = '%B %d, %Y'
68
69# List of patterns, relative to source directory, that match files and
70# directories to ignore when looking for source files.
71exclude_patterns = ['_build']
72
73# The reST default role (used for this markup: `text`) to use for all
74# documents.
75#default_role = None
76
77# If true, '()' will be appended to :func: etc. cross-reference text.
78#add_function_parentheses = True
79
80# If true, the current module name will be prepended to all description
81# unit titles (such as .. function::).
82#add_module_names = True
83
84# If true, sectionauthor and moduleauthor directives will be shown in the
85# output. They are ignored by default.
86#show_authors = False
87
88# The name of the Pygments (syntax highlighting) style to use.
89pygments_style = 'sphinx'
90
91# A list of ignored prefixes for module index sorting.
92#modindex_common_prefix = []
93
94# If true, keep warnings as "system message" paragraphs in the built documents.
95#keep_warnings = False
96
97
98# -- Options for HTML output ----------------------------------------------
99
100html_theme = "sphinx_rtd_theme"
101
102html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
103
104# The name for this set of Sphinx documents. If None, it defaults to
105# "<project> v<release> documentation".
106#html_title = None
107
108# A shorter title for the navigation bar. Default is the same as html_title.
109#html_short_title = None
110
111# The name of an image file (relative to this directory) to place at the top
112# of the sidebar.
113#html_logo = None
114
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
117# pixels large.
118#html_favicon = None
119
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".
123html_static_path = ['_static']
124
125# Add any extra paths that contain custom files (such as robots.txt or
126# .htaccess) here, relative to this directory. These files are copied
127# directly to the root of the documentation.
128#html_extra_path = []
129
130# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
131# using the given strftime format.
132#html_last_updated_fmt = '%b %d, %Y'
133
134# If true, SmartyPants will be used to convert quotes and dashes to
135# typographically correct entities.
136#html_use_smartypants = True
137
138# Custom sidebar templates, maps document names to template names.
139#html_sidebars = {}
140
141# Additional templates that should be rendered to pages, maps page names to
142# template names.
143#html_additional_pages = {}
144
145# If false, no module index is generated.
146#html_domain_indices = True
147
148# If false, no index is generated.
149#html_use_index = True
150
151# If true, the index is split into individual pages for each letter.
152#html_split_index = False
153
154# If true, links to the reST sources are added to the pages.
155#html_show_sourcelink = True
156
157# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
158#html_show_sphinx = True
159
160# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
161#html_show_copyright = True
162
163# If true, an OpenSearch description file will be output, and all pages will
164# contain a <link> tag referring to it. The value of this option must be the
165# base URL from which the finished HTML is served.
166#html_use_opensearch = ''
167
168# This is the file name suffix for HTML files (e.g. ".xhtml").
169#html_file_suffix = None
170
171# Output file base name for HTML help builder.
172htmlhelp_basename = 'auf-django-sdkdoc'
173
174
175# -- Options for LaTeX output ---------------------------------------------
176
177latex_elements = {
178# The paper size ('letterpaper' or 'a4paper').
179#'papersize': 'letterpaper',
180
181# The font size ('10pt', '11pt' or '12pt').
182#'pointsize': '10pt',
183
184# Additional stuff for the LaTeX preamble.
185#'preamble': '',
186}
187
188# Grouping the document tree into LaTeX files. List of tuples
189# (source start file, target name, title,
190# author, documentclass [howto, manual, or own class]).
191latex_documents = [
192 ('index', 'auf-django-sdk.tex', u'auf-django-sdk Documentation',
193 u'Patrick Hetu', 'manual'),
194]
195
196# The name of an image file (relative to this directory) to place at the top of
197# the title page.
198#latex_logo = None
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# Documents to append as an appendix to all manuals.
211#latex_appendices = []
212
213# If false, no module index is generated.
214#latex_domain_indices = True
215
216
217# -- Options for manual page output ---------------------------------------
218
219# One entry per manual page. List of tuples
220# (source start file, name, description, authors, manual section).
221man_pages = [
222 ('index', 'auf-django-sdk', u'auf-django-sdk Documentation',
223 [u'Patrick Hetu'], 1)
224]
225
226# If true, show URL addresses after external links.
227#man_show_urls = False
228
229
230# -- Options for Texinfo output -------------------------------------------
231
232# Grouping the document tree into Texinfo files. List of tuples
233# (source start file, target name, title, author,
234# dir menu entry, description, category)
235texinfo_documents = [
236 ('index', 'auf-django-sdk', u'auf-django-sdk Documentation',
237 u'Patrick Hetu', 'auf-django-sdk', 'One line description of project.',
238 'Miscellaneous'),
239]
240
241# Documents to append as an appendix to all manuals.
242#texinfo_appendices = []
243
244# If false, no module index is generated.
245#texinfo_domain_indices = True
246
247# How to display URL addresses: 'footnote', 'no', or 'inline'.
248#texinfo_show_urls = 'footnote'
249
250# If true, do not generate a @detailmenu in the "Top" node's menu.
251#texinfo_no_detailmenu = False