]>
git.proxmox.com Git - proxmox-backup.git/blob - docs/conf.py
2 # -*- coding: utf-8 -*-
4 # Proxmox Backup documentation build configuration file, originally
5 # created by sphinx-quickstart on Tue Feb 26 16:54:35 2019.
7 # This file is execfile()d with the current directory set to its
10 # Note that not all possible configuration values are present in this
13 # All configuration values have a default; values that are commented out
14 # 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.
22 # sys.path.insert(0, os.path.abspath('.'))
24 # -- General configuration ------------------------------------------------
26 # If your documentation needs a minimal Sphinx version, state it here.
28 # needs_sphinx = '1.0'
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path
= ['_templates']
38 # The suffix(es) of source filenames.
39 # You can specify multiple suffix as a list of string:
41 # source_suffix = ['.rst', '.md']
42 source_suffix
= '.rst'
44 # The encoding of source files.
46 # source_encoding = 'utf-8-sig'
48 # The master toctree document.
51 # General information about the project.
52 project
= 'Proxmox Backup'
53 copyright
= '2019, Proxmox Support Team'
54 author
= 'Proxmox Support Team'
56 # The version info for the project you're documenting, acts as replacement for
57 # |version| and |release|, also used in various other places throughout the
60 # The short X.Y version.
62 # The full version, including alpha/beta/rc tags.
65 # The language for content autogenerated by Sphinx. Refer to documentation
66 # for a list of supported languages.
68 # This is also used if you do content translation via gettext catalogs.
69 # Usually you set "language" from the command line for these cases.
72 # There are two options for replacing |today|: either, you set today to some
73 # non-false value, then it is used:
77 # Else, today_fmt is used as the format for a strftime call.
79 # today_fmt = '%B %d, %Y'
81 # List of patterns, relative to source directory, that match files and
82 # directories to ignore when looking for source files.
83 # This patterns also effect to html_static_path and html_extra_path
85 '_build', 'Thumbs.db', '.DS_Store',
86 'proxmox-backup-client/man1.rst',
90 # The reST default role (used for this markup: `text`) to use for all
95 # If true, '()' will be appended to :func: etc. cross-reference text.
97 # add_function_parentheses = True
99 # If true, the current module name will be prepended to all description
100 # unit titles (such as .. function::).
102 # add_module_names = True
104 # If true, sectionauthor and moduleauthor directives will be shown in the
105 # output. They are ignored by default.
107 # show_authors = False
109 # The name of the Pygments (syntax highlighting) style to use.
110 pygments_style
= 'sphinx'
112 # A list of ignored prefixes for module index sorting.
113 # modindex_common_prefix = []
115 # If true, keep warnings as "system message" paragraphs in the built documents.
116 # keep_warnings = False
118 # If true, `todo` and `todoList` produce output, else they produce nothing.
119 todo_include_todos
= False
122 # -- Options for HTML output ----------------------------------------------
124 # The theme to use for HTML and HTML Help pages. See the documentation for
125 # a list of builtin themes.
127 html_theme
= 'sphinxdoc'
129 # Theme options are theme-specific and customize the look and feel of a theme
130 # further. For a list of options available for each theme, see the
133 # html_theme_options = {}
135 # Add any paths that contain custom themes here, relative to this directory.
136 # html_theme_path = []
138 # The name for this set of Sphinx documents.
139 # "<project> v<release> documentation" by default.
141 # html_title = 'Proxmox Backup v1.0-1'
143 # A shorter title for the navigation bar. Default is the same as html_title.
145 # html_short_title = None
147 # The name of an image file (relative to this directory) to place at the top
150 html_logo
= 'images/proxmox-logo.svg'
152 # The name of an image file (relative to this directory) to use as a favicon of
153 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
156 html_favicon
= 'images/favicon.ico'
158 # Add any paths that contain custom static files (such as style sheets) here,
159 # relative to this directory. They are copied after the builtin static files,
160 # so a file named "default.css" will overwrite the builtin "default.css".
161 html_static_path
= ['_static']
163 # Add any extra paths that contain custom files (such as robots.txt or
164 # .htaccess) here, relative to this directory. These files are copied
165 # directly to the root of the documentation.
167 # html_extra_path = []
169 # If not None, a 'Last updated on:' timestamp is inserted at every page
170 # bottom, using the given strftime format.
171 # The empty string is equivalent to '%b %d, %Y'.
173 # html_last_updated_fmt = None
175 # If true, SmartyPants will be used to convert quotes and dashes to
176 # typographically correct entities.
178 # html_use_smartypants = True
180 # Custom sidebar templates, maps document names to template names.
184 # Additional templates that should be rendered to pages, maps page names to
187 # html_additional_pages = {}
189 # If false, no module index is generated.
191 # html_domain_indices = True
193 # If false, no index is generated.
195 # html_use_index = True
197 # If true, the index is split into individual pages for each letter.
199 # html_split_index = False
201 # If true, links to the reST sources are added to the pages.
203 # html_show_sourcelink = True
205 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
207 # html_show_sphinx = True
209 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
211 # html_show_copyright = True
213 # If true, an OpenSearch description file will be output, and all pages will
214 # contain a <link> tag referring to it. The value of this option must be the
215 # base URL from which the finished HTML is served.
217 # html_use_opensearch = ''
219 # This is the file name suffix for HTML files (e.g. ".xhtml").
220 # html_file_suffix = None
222 # Language to be used for generating the HTML full-text search index.
223 # Sphinx supports the following languages:
224 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
225 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
227 # html_search_language = 'en'
229 # A dictionary with options for the search language support, empty by default.
230 # 'ja' uses this config value.
231 # 'zh' user can custom change `jieba` dictionary path.
233 # html_search_options = {'type': 'default'}
235 # The name of a javascript file (relative to the configuration directory) that
236 # implements a search results scorer. If empty, the default will be used.
238 # html_search_scorer = 'scorer.js'
240 # Output file base name for HTML help builder.
241 htmlhelp_basename
= 'ProxmoxBackupdoc'
243 # -- Options for LaTeX output ---------------------------------------------
246 # The paper size ('letterpaper' or 'a4paper').
248 'papersize': 'a4paper',
250 # The font size ('10pt', '11pt' or '12pt').
254 # Additional stuff for the LaTeX preamble.
258 # Latex figure (float) alignment
260 # 'figure_align': 'htbp',
263 # Grouping the document tree into LaTeX files. List of tuples
264 # (source start file, target name, title,
265 # author, documentclass [howto, manual, or own class]).
267 (master_doc
, 'ProxmoxBackup.tex', 'Proxmox Backup Documentation',
268 'Proxmox Support Team', 'manual'),
271 # The name of an image file (relative to this directory) to place at the top of
275 # Note: newer sphinx 1.6 should be able to convert .svg to .png
276 # automatically using sphinx.ext.imgconverter
277 latex_logo
= "images/proxmox-logo.png"
279 # For "manual" documents, if this is true, then toplevel headings are parts,
282 # latex_use_parts = False
284 # If true, show page references after internal links.
286 # latex_show_pagerefs = False
288 # If true, show URL addresses after external links.
290 # latex_show_urls = False
292 # Documents to append as an appendix to all manuals.
294 # latex_appendices = []
296 # It false, will not define \strong, \code, itleref, \crossref ... but only
297 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
300 # latex_keep_old_macro_names = True
302 # If false, no module index is generated.
304 # latex_domain_indices = True
307 # -- Options for Epub output ----------------------------------------------
309 # Bibliographic Dublin Core info.
312 epub_publisher
= author
313 epub_copyright
= copyright
315 # The basename for the epub file. It defaults to the project name.
316 # epub_basename = project
318 # The HTML theme for the epub output. Since the default themes are not
319 # optimized for small screen space, using the same theme for HTML and epub
320 # output is usually not wise. This defaults to 'epub', a theme designed to save
323 # epub_theme = 'epub'
325 # The language of the text. It defaults to the language option
326 # or 'en' if the language is not set.
330 # The scheme of the identifier. Typical schemes are ISBN or URL.
333 # The unique identifier of the text. This can be a ISBN number
334 # or the project homepage.
336 # epub_identifier = ''
338 # A unique identification for the text.
342 # A tuple containing the cover image and cover page html template filenames.
346 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
350 # HTML files that should be inserted before the pages created by sphinx.
351 # The format is a list of tuples containing the path and title.
353 # epub_pre_files = []
355 # HTML files that should be inserted after the pages created by sphinx.
356 # The format is a list of tuples containing the path and title.
358 # epub_post_files = []
360 # A list of files that should not be packed into the epub file.
361 epub_exclude_files
= ['search.html']
363 # The depth of the table of contents in toc.ncx.
367 # Allow duplicate toc entries.
371 # Choose between 'default' and 'includehidden'.
373 # epub_tocscope = 'default'
375 # Fix unsupported image types using the Pillow.
377 # epub_fix_images = False
379 # Scale large images.
381 # epub_max_image_width = 0
383 # How to display URL addresses: 'footnote', 'no', or 'inline'.
385 # epub_show_urls = 'inline'
387 # If false, no index is generated.
389 # epub_use_index = True