Fix 500 error when "related_territories_id" is None
[infos-pratiques:etalage.git] / docs / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # Etalage documentation build configuration file, created by
4 # sphinx-quickstart on Mon Sep 29 17:01:04 2014.
5 #
6 # This file is execfile()d with the current directory set to its
7 # containing dir.
8 #
9 # Note that not all possible configuration values are present in this
10 # autogenerated file.
11 #
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
14
15 import sys
16 import os
17
18 # If extensions (or modules to document with autodoc) are in another directory,
19 # add these directories to sys.path here. If the directory is relative to the
20 # documentation root, use os.path.abspath to make it absolute, like shown here.
21 #sys.path.insert(0, os.path.abspath('.'))
22
23 # -- General configuration ------------------------------------------------
24
25 # If your documentation needs a minimal Sphinx version, state it here.
26 #needs_sphinx = '1.0'
27
28 # Add any Sphinx extension module names here, as strings. They can be
29 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30 # ones.
31 extensions = [
32     'sphinx.ext.autodoc',
33     'sphinx.ext.doctest',
34     'sphinx.ext.intersphinx',
35 ]
36
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = ['_templates']
39
40 # The suffix of source filenames.
41 source_suffix = '.rst'
42
43 # The encoding of source files.
44 #source_encoding = 'utf-8-sig'
45
46 # The master toctree document.
47 master_doc = 'index'
48
49 # General information about the project.
50 project = u'Etalage'
51 copyright = u'2014, Romain Soufflet'
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.
58 version = '1.0'
59 # The full version, including alpha/beta/rc tags.
60 release = '1.0'
61
62 # The language for content autogenerated by Sphinx. Refer to documentation
63 # for a list of supported languages.
64 #language = None
65
66 # There are two options for replacing |today|: either, you set today to some
67 # non-false value, then it is used:
68 #today = ''
69 # Else, today_fmt is used as the format for a strftime call.
70 #today_fmt = '%B %d, %Y'
71
72 # List of patterns, relative to source directory, that match files and
73 # directories to ignore when looking for source files.
74 exclude_patterns = ['_build']
75
76 # The reST default role (used for this markup: `text`) to use for all
77 # documents.
78 #default_role = None
79
80 # If true, '()' will be appended to :func: etc. cross-reference text.
81 #add_function_parentheses = True
82
83 # If true, the current module name will be prepended to all description
84 # unit titles (such as .. function::).
85 #add_module_names = True
86
87 # If true, sectionauthor and moduleauthor directives will be shown in the
88 # output. They are ignored by default.
89 #show_authors = False
90
91 # The name of the Pygments (syntax highlighting) style to use.
92 pygments_style = 'sphinx'
93
94 # A list of ignored prefixes for module index sorting.
95 #modindex_common_prefix = []
96
97 # If true, keep warnings as "system message" paragraphs in the built documents.
98 #keep_warnings = False
99
100
101 # -- Options for HTML output ----------------------------------------------
102
103 # The theme to use for HTML and HTML Help pages.  See the documentation for
104 # a list of builtin themes.
105 html_theme = 'default'
106 # on_rtd is whether we are on readthedocs.org
107 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
108 if not on_rtd:  # only import and set the theme if we're building docs locally
109     html_theme = 'sphinx_rtd_theme'
110     html_theme_path = ['_themes']
111 # otherwise, readthedocs.org uses their theme by default, so no need to specify it
112
113 # Theme options are theme-specific and customize the look and feel of a theme
114 # further.  For a list of options available for each theme, see the
115 # documentation.
116 #html_theme_options = {}
117
118 # Add any paths that contain custom themes here, relative to this directory.
119 #html_theme_path = []
120
121 # The name for this set of Sphinx documents.  If None, it defaults to
122 # "<project> v<release> documentation".
123 #html_title = None
124
125 # A shorter title for the navigation bar.  Default is the same as html_title.
126 #html_short_title = None
127
128 # The name of an image file (relative to this directory) to place at the top
129 # of the sidebar.
130 #html_logo = None
131
132 # The name of an image file (within the static path) to use as favicon of the
133 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
134 # pixels large.
135 #html_favicon = None
136
137 # Add any paths that contain custom static files (such as style sheets) here,
138 # relative to this directory. They are copied after the builtin static files,
139 # so a file named "default.css" will overwrite the builtin "default.css".
140 html_static_path = ['_static']
141
142 # Add any extra paths that contain custom files (such as robots.txt or
143 # .htaccess) here, relative to this directory. These files are copied
144 # directly to the root of the documentation.
145 #html_extra_path = []
146
147 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
148 # using the given strftime format.
149 #html_last_updated_fmt = '%b %d, %Y'
150
151 # If true, SmartyPants will be used to convert quotes and dashes to
152 # typographically correct entities.
153 #html_use_smartypants = True
154
155 # Custom sidebar templates, maps document names to template names.
156 #html_sidebars = {}
157
158 # Additional templates that should be rendered to pages, maps page names to
159 # template names.
160 #html_additional_pages = {}
161
162 # If false, no module index is generated.
163 #html_domain_indices = True
164
165 # If false, no index is generated.
166 #html_use_index = True
167
168 # If true, the index is split into individual pages for each letter.
169 #html_split_index = False
170
171 # If true, links to the reST sources are added to the pages.
172 #html_show_sourcelink = True
173
174 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
175 #html_show_sphinx = True
176
177 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
178 #html_show_copyright = True
179
180 # If true, an OpenSearch description file will be output, and all pages will
181 # contain a <link> tag referring to it.  The value of this option must be the
182 # base URL from which the finished HTML is served.
183 #html_use_opensearch = ''
184
185 # This is the file name suffix for HTML files (e.g. ".xhtml").
186 #html_file_suffix = None
187
188 # Output file base name for HTML help builder.
189 htmlhelp_basename = 'Etalagedoc'
190
191
192 # -- Options for LaTeX output ---------------------------------------------
193
194 latex_elements = {
195 # The paper size ('letterpaper' or 'a4paper').
196 #'papersize': 'letterpaper',
197
198 # The font size ('10pt', '11pt' or '12pt').
199 #'pointsize': '10pt',
200
201 # Additional stuff for the LaTeX preamble.
202 #'preamble': '',
203 }
204
205 # Grouping the document tree into LaTeX files. List of tuples
206 # (source start file, target name, title,
207 #  author, documentclass [howto, manual, or own class]).
208 latex_documents = [
209   ('index', 'Etalage.tex', u'Etalage Documentation',
210    u'Romain Soufflet', 'manual'),
211 ]
212
213 # The name of an image file (relative to this directory) to place at the top of
214 # the title page.
215 #latex_logo = None
216
217 # For "manual" documents, if this is true, then toplevel headings are parts,
218 # not chapters.
219 #latex_use_parts = False
220
221 # If true, show page references after internal links.
222 #latex_show_pagerefs = False
223
224 # If true, show URL addresses after external links.
225 #latex_show_urls = False
226
227 # Documents to append as an appendix to all manuals.
228 #latex_appendices = []
229
230 # If false, no module index is generated.
231 #latex_domain_indices = True
232
233
234 # -- Options for manual page output ---------------------------------------
235
236 # One entry per manual page. List of tuples
237 # (source start file, name, description, authors, manual section).
238 man_pages = [
239     ('index', 'etalage', u'Etalage Documentation',
240      [u'Romain Soufflet'], 1)
241 ]
242
243 # If true, show URL addresses after external links.
244 #man_show_urls = False
245
246
247 # -- Options for Texinfo output -------------------------------------------
248
249 # Grouping the document tree into Texinfo files. List of tuples
250 # (source start file, target name, title, author,
251 #  dir menu entry, description, category)
252 texinfo_documents = [
253   ('index', 'Etalage', u'Etalage Documentation',
254    u'Romain Soufflet', 'Etalage', 'One line description of project.',
255    'Miscellaneous'),
256 ]
257
258 # Documents to append as an appendix to all manuals.
259 #texinfo_appendices = []
260
261 # If false, no module index is generated.
262 #texinfo_domain_indices = True
263
264 # How to display URL addresses: 'footnote', 'no', or 'inline'.
265 #texinfo_show_urls = 'footnote'
266
267 # If true, do not generate a @detailmenu in the "Top" node's menu.
268 #texinfo_no_detailmenu = False
269
270
271 # Example configuration for intersphinx: refer to the Python standard library.
272 intersphinx_mapping = {'http://docs.python.org/': None}