]>
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
33 extensions
= ["sphinx.ext.graphviz"]
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 epilog_file
= open('epilog.rst', 'r')
52 rst_epilog
= epilog_file
.read()
54 # General information about the project.
55 project
= 'Proxmox Backup'
56 copyright
= '2019, Proxmox Support Team'
57 author
= 'Proxmox Support Team'
59 # The version info for the project you're documenting, acts as replacement for
60 # |version| and |release|, also used in various other places throughout the
63 # The short X.Y version.
65 # The full version, including alpha/beta/rc tags.
68 # The language for content autogenerated by Sphinx. Refer to documentation
69 # for a list of supported languages.
71 # This is also used if you do content translation via gettext catalogs.
72 # Usually you set "language" from the command line for these cases.
75 # There are two options for replacing |today|: either, you set today to some
76 # non-false value, then it is used:
80 # Else, today_fmt is used as the format for a strftime call.
82 # today_fmt = '%B %d, %Y'
84 # List of patterns, relative to source directory, that match files and
85 # directories to ignore when looking for source files.
86 # This patterns also effect to html_static_path and html_extra_path
88 '_build', 'Thumbs.db', '.DS_Store',
89 'proxmox-backup-client/man1.rst',
90 'proxmox-backup-manager/man1.rst',
91 'proxmox-backup-proxy/man1.rst',
95 'package-repositories.rst',
98 # The reST default role (used for this markup: `text`) to use for all
101 # default_role = None
103 # If true, '()' will be appended to :func: etc. cross-reference text.
105 # add_function_parentheses = True
107 # If true, the current module name will be prepended to all description
108 # unit titles (such as .. function::).
110 # add_module_names = True
112 # If true, sectionauthor and moduleauthor directives will be shown in the
113 # output. They are ignored by default.
115 # show_authors = False
117 # The name of the Pygments (syntax highlighting) style to use.
118 pygments_style
= 'sphinx'
120 # A list of ignored prefixes for module index sorting.
121 # modindex_common_prefix = []
123 # If true, keep warnings as "system message" paragraphs in the built documents.
124 # keep_warnings = False
126 # If true, `todo` and `todoList` produce output, else they produce nothing.
127 todo_include_todos
= False
130 # -- Options for HTML output ----------------------------------------------
132 # The theme to use for HTML and HTML Help pages. See the documentation for
133 # a list of builtin themes.
135 html_theme
= 'sphinxdoc'
137 # Theme options are theme-specific and customize the look and feel of a theme
138 # further. For a list of options available for each theme, see the
141 # html_theme_options = {}
143 # Add any paths that contain custom themes here, relative to this directory.
144 # html_theme_path = []
146 # The name for this set of Sphinx documents.
147 # "<project> v<release> documentation" by default.
149 # html_title = 'Proxmox Backup v1.0-1'
151 # A shorter title for the navigation bar. Default is the same as html_title.
153 # html_short_title = None
155 # The name of an image file (relative to this directory) to place at the top
158 html_logo
= 'images/proxmox-logo.svg'
160 # The name of an image file (relative to this directory) to use as a favicon of
161 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
164 html_favicon
= 'images/favicon.ico'
166 # Add any paths that contain custom static files (such as style sheets) here,
167 # relative to this directory. They are copied after the builtin static files,
168 # so a file named "default.css" will overwrite the builtin "default.css".
169 html_static_path
= ['_static']
171 # Add any extra paths that contain custom files (such as robots.txt or
172 # .htaccess) here, relative to this directory. These files are copied
173 # directly to the root of the documentation.
175 # html_extra_path = []
177 # If not None, a 'Last updated on:' timestamp is inserted at every page
178 # bottom, using the given strftime format.
179 # The empty string is equivalent to '%b %d, %Y'.
181 # html_last_updated_fmt = None
183 # If true, SmartyPants will be used to convert quotes and dashes to
184 # typographically correct entities.
186 # html_use_smartypants = True
188 # Custom sidebar templates, maps document names to template names.
192 # Additional templates that should be rendered to pages, maps page names to
195 # html_additional_pages = {}
197 # If false, no module index is generated.
199 # html_domain_indices = True
201 # If false, no index is generated.
203 # html_use_index = True
205 # If true, the index is split into individual pages for each letter.
207 # html_split_index = False
209 # If true, links to the reST sources are added to the pages.
211 # html_show_sourcelink = True
213 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
215 # html_show_sphinx = True
217 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
219 # html_show_copyright = True
221 # If true, an OpenSearch description file will be output, and all pages will
222 # contain a <link> tag referring to it. The value of this option must be the
223 # base URL from which the finished HTML is served.
225 # html_use_opensearch = ''
227 # This is the file name suffix for HTML files (e.g. ".xhtml").
228 # html_file_suffix = None
230 # Language to be used for generating the HTML full-text search index.
231 # Sphinx supports the following languages:
232 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
233 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
235 # html_search_language = 'en'
237 # A dictionary with options for the search language support, empty by default.
238 # 'ja' uses this config value.
239 # 'zh' user can custom change `jieba` dictionary path.
241 # html_search_options = {'type': 'default'}
243 # The name of a javascript file (relative to the configuration directory) that
244 # implements a search results scorer. If empty, the default will be used.
246 # html_search_scorer = 'scorer.js'
248 # Output file base name for HTML help builder.
249 htmlhelp_basename
= 'ProxmoxBackupdoc'
251 # -- Options for LaTeX output ---------------------------------------------
254 # The paper size ('letterpaper' or 'a4paper').
256 'papersize': 'a4paper',
258 # The font size ('10pt', '11pt' or '12pt').
262 # Additional stuff for the LaTeX preamble.
266 # Latex figure (float) alignment
268 # 'figure_align': 'htbp',
271 # Grouping the document tree into LaTeX files. List of tuples
272 # (source start file, target name, title,
273 # author, documentclass [howto, manual, or own class]).
275 (master_doc
, 'ProxmoxBackup.tex', 'Proxmox Backup Documentation',
276 'Proxmox Support Team', 'manual'),
279 # The name of an image file (relative to this directory) to place at the top of
283 # Note: newer sphinx 1.6 should be able to convert .svg to .png
284 # automatically using sphinx.ext.imgconverter
285 latex_logo
= "images/proxmox-logo.png"
287 # For "manual" documents, if this is true, then toplevel headings are parts,
290 # latex_use_parts = False
292 # If true, show page references after internal links.
294 # latex_show_pagerefs = False
296 # If true, show URL addresses after external links.
298 # latex_show_urls = False
300 # Documents to append as an appendix to all manuals.
302 # latex_appendices = []
304 # It false, will not define \strong, \code, itleref, \crossref ... but only
305 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
308 # latex_keep_old_macro_names = True
310 # If false, no module index is generated.
312 # latex_domain_indices = True
315 # -- Options for Epub output ----------------------------------------------
317 # Bibliographic Dublin Core info.
320 epub_publisher
= author
321 epub_copyright
= copyright
323 # The basename for the epub file. It defaults to the project name.
324 # epub_basename = project
326 # The HTML theme for the epub output. Since the default themes are not
327 # optimized for small screen space, using the same theme for HTML and epub
328 # output is usually not wise. This defaults to 'epub', a theme designed to save
331 # epub_theme = 'epub'
333 # The language of the text. It defaults to the language option
334 # or 'en' if the language is not set.
338 # The scheme of the identifier. Typical schemes are ISBN or URL.
341 # The unique identifier of the text. This can be a ISBN number
342 # or the project homepage.
344 # epub_identifier = ''
346 # A unique identification for the text.
350 # A tuple containing the cover image and cover page html template filenames.
354 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
358 # HTML files that should be inserted before the pages created by sphinx.
359 # The format is a list of tuples containing the path and title.
361 # epub_pre_files = []
363 # HTML files that should be inserted after the pages created by sphinx.
364 # The format is a list of tuples containing the path and title.
366 # epub_post_files = []
368 # A list of files that should not be packed into the epub file.
369 epub_exclude_files
= ['search.html']
371 # The depth of the table of contents in toc.ncx.
375 # Allow duplicate toc entries.
379 # Choose between 'default' and 'includehidden'.
381 # epub_tocscope = 'default'
383 # Fix unsupported image types using the Pillow.
385 # epub_fix_images = False
387 # Scale large images.
389 # epub_max_image_width = 0
391 # How to display URL addresses: 'footnote', 'no', or 'inline'.
393 # epub_show_urls = 'inline'
395 # If false, no index is generated.
397 # epub_use_index = True