Debian Codegraph @

doc/fr/conf.py

raw ◀ ▶
Source reconstructed at patch state 0 of 1 — not the installed (fully patched) source.
1 Debian patch touch this file
1 # -*- coding: utf-8 -*-
2 #
3 # Centreon documentation build configuration file, created by
4 # sphinx-quickstart on Wed Nov 7 16:30:34 2012.
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
14 import sys, os
15
16 on_centreon_rtd = os.environ.get('CENTREON_RTD', None) == 'True'
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 extensions
29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30 extensions = ['sphinx.ext.todo', 'sphinx.ext.intersphinx']
31
32 intersphinx_mapping = {
33 'centreon-engine': ('http://documentation.centreon.com/docs/centreon-engine/en/latest', None),
34 'centreon-broker': ('http://documentation.centreon.com/docs/centreon-broker/en/latest', None),
35 'centreon-clib': ('http://documentation.centreon.com/docs/centreon-clib/en/latest', None),
36 'ces': ('http://documentation.centreon.com/docs/centreon-enterprise-server/en/latest', None),
37 }
38
39 # Add any paths that contain templates here, relative to this directory.
40 templates_path = ['_templates']
41
42 todo_include_todos = True
43
44 # The suffix of source filenames.
45 source_suffix = '.rst'
46
47 # The encoding of source files.
48 #source_encoding = 'utf-8-sig'
49
50 # The master toctree document.
51 master_doc = 'index'
52
53 # General information about the project.
54 project = u'Centreon Plugins'
55 copyright = u'2007-2020 Centreon'
56
57 # The version info for the project you're documenting, acts as replacement for
58 # |version| and |release|, also used in various other places throughout the
59 # built documents.
60 #
61 # The short X.Y version.
62 version = 'latest'
63 # The full version, including alpha/beta/rc tags.
64 release = 'latest'
65
66 # The language for content autogenerated by Sphinx. Refer to documentation
67 # for a list of supported languages.
68 #language = None
69
70 # There are two options for replacing |today|: either, you set today to some
71 # non-false value, then it is used:
72 #today = ''
73 # Else, today_fmt is used as the format for a strftime call.
74 #today_fmt = '%B %d, %Y'
75
76 # List of patterns, relative to source directory, that match files and
77 # directories to ignore when looking for source files.
78 exclude_patterns = ['_build']
79
80 # The reST default role (used for this markup: `text`) to use for all documents.
81 #default_role = None
82
83 # If true, '()' will be appended to :func: etc. cross-reference text.
84 #add_function_parentheses = True
85
86 # If true, the current module name will be prepended to all description
87 # unit titles (such as .. function::).
88 #add_module_names = True
89
90 # If true, sectionauthor and moduleauthor directives will be shown in the
91 # output. They are ignored by default.
92 #show_authors = False
93
94 # The name of the Pygments (syntax highlighting) style to use.
95 pygments_style = 'sphinx'
96
97 # A list of ignored prefixes for module index sorting.
98 #modindex_common_prefix = []
99
100
101 # -- Options for HTML output ---------------------------------------------------
102
103 if on_centreon_rtd:
104 # The theme to use for HTML and HTML Help pages. See the documentation for
105 # a list of builtin themes.
106 html_theme = 'centreon'
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 = ['/srv/themes']
115 else:
116 html_theme = 'default'
117
118 # The name for this set of Sphinx documents. If None, it defaults to
119 # "<project> v<release> documentation".
120 #html_title = None
121
122 # A shorter title for the navigation bar. Default is the same as html_title.
123 #html_short_title = None
124
125 # The name of an image file (relative to this directory) to place at the top
126 # of the sidebar.
127 #html_logo = None
128
129 # The name of an image file (within the static path) to use as favicon of the
130 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
131 # pixels large.
132 #html_favicon = None
133
134 # Add any paths that contain custom static files (such as style sheets) here,
135 # relative to this directory. They are copied after the builtin static files,
136 # so a file named "default.css" will overwrite the builtin "default.css".
137 html_static_path = ['_static']
138
139 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
140 # using the given strftime format.
141 #html_last_updated_fmt = '%b %d, %Y'
142
143 # If true, SmartyPants will be used to convert quotes and dashes to
144 # typographically correct entities.
145 #html_use_smartypants = True
146
147 # Custom sidebar templates, maps document names to template names.
148 #html_sidebars = {}
149
150 # Additional templates that should be rendered to pages, maps page names to
151 # template names.
152 #html_additional_pages = {}
153
154 # If false, no module index is generated.
155 #html_domain_indices = True
156
157 # If false, no index is generated.
158 #html_use_index = True
159
160 # If true, the index is split into individual pages for each letter.
161 #html_split_index = False
162
163 # If true, links to the reST sources are added to the pages.
164 #html_show_sourcelink = True
165
166 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
167 #html_show_sphinx = True
168
169 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
170 #html_show_copyright = True
171
172 # If true, an OpenSearch description file will be output, and all pages will
173 # contain a <link> tag referring to it. The value of this option must be the
174 # base URL from which the finished HTML is served.
175 #html_use_opensearch = ''
176
177 # This is the file name suffix for HTML files (e.g. ".xhtml").
178 #html_file_suffix = None
179
180 # Output file base name for HTML help builder.
181 htmlhelp_basename = 'Centreondoc'
182
183
184 # -- Options for LaTeX output --------------------------------------------------
185
186 latex_elements = {
187 # The paper size ('letterpaper' or 'a4paper').
188 #'papersize': 'letterpaper',
189
190 # The font size ('10pt', '11pt' or '12pt').
191 #'pointsize': '10pt',
192
193 # Additional stuff for the LaTeX preamble.
194 #'preamble': '',
195 }
196
197 # Grouping the document tree into LaTeX files. List of tuples
198 # (source start file, target name, title, author, documentclass [howto/manual]).
199 latex_documents = [
200 ('index', 'Centreon.tex', u'Centreon Plugins Documentation',
201 u'Merethis', 'manual'),
202 ]
203
204 # The name of an image file (relative to this directory) to place at the top of
205 # the title page.
206 #latex_logo = None
207
208 # For "manual" documents, if this is true, then toplevel headings are parts,
209 # not chapters.
210 #latex_use_parts = False
211
212 # If true, show page references after internal links.
213 #latex_show_pagerefs = False
214
215 # If true, show URL addresses after external links.
216 #latex_show_urls = False
217
218 # Documents to append as an appendix to all manuals.
219 #latex_appendices = []
220
221 # If false, no module index is generated.
222 #latex_domain_indices = True
223
224
225 # -- Options for manual page output --------------------------------------------
226
227 # One entry per manual page. List of tuples
228 # (source start file, name, description, authors, manual section).
229 man_pages = [
230 ('index', 'centreon', u'Centreon Plugins Documentation',
231 [u'Merethis'], 1)
232 ]
233
234 # If true, show URL addresses after external links.
235 #man_show_urls = False
236
237
238 # -- Options for Texinfo output ------------------------------------------------
239
240 # Grouping the document tree into Texinfo files. List of tuples
241 # (source start file, target name, title, author,
242 # dir menu entry, description, category)
243 texinfo_documents = [
244 ('index', 'Centreon', u'Centreon Documentation',
245 u'Merethis', 'Centreon', 'One line description of project.',
246 'Miscellaneous'),
247 ]
248
249 # Documents to append as an appendix to all manuals.
250 #texinfo_appendices = []
251
252 # If false, no module index is generated.
253 #texinfo_domain_indices = True
254
255 # How to display URL addresses: 'footnote', 'no', or 'inline'.
256 #texinfo_show_urls = 'footnote'