2019-02-27 19:42:31 +03:00
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Proxmox Backup documentation build configuration file, originally
# created by sphinx-quickstart on Tue Feb 26 16:54:35 2019.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
2020-07-04 18:51:56 +03:00
import os
2020-09-02 15:22:36 +03:00
import sys
2019-02-27 19:42:31 +03:00
# sys.path.insert(0, os.path.abspath('.'))
2020-09-02 15:22:36 +03:00
# custom extensions
sys . path . append ( os . path . abspath ( " ./_ext " ) )
2020-05-04 10:02:10 +03:00
# -- Implement custom formatter for code-blocks ---------------------------
#
# * use smaller font
# * avoid space between lines to nicely format utf8 tables
from sphinx . highlighting import PygmentsBridge
from pygments . formatters . latex import LatexFormatter
class CustomLatexFormatter ( LatexFormatter ) :
def __init__ ( self , * * options ) :
super ( CustomLatexFormatter , self ) . __init__ ( * * options )
self . verboptions = r " formatcom= \ footnotesize \ relax \ let \ strut \ empty "
PygmentsBridge . latex_formatter = CustomLatexFormatter
2019-02-27 19:42:31 +03:00
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
2020-07-04 18:53:58 +03:00
2021-04-05 12:59:43 +03:00
extensions = [ " sphinx.ext.graphviz " , ' sphinx.ext.mathjax ' , " sphinx.ext.todo " , " proxmox-scanrefs " ]
2019-02-27 19:42:31 +03:00
2020-07-04 18:53:58 +03:00
todo_link_only = True
2019-02-27 19:42:31 +03:00
# Add any paths that contain templates here, relative to this directory.
templates_path = [ ' _templates ' ]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ' .rst '
# The encoding of source files.
#
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = ' index '
2019-03-02 12:31:32 +03:00
epilog_file = open ( ' epilog.rst ' , ' r ' )
rst_epilog = epilog_file . read ( )
2019-02-27 19:42:31 +03:00
# General information about the project.
project = ' Proxmox Backup '
2021-02-03 14:04:27 +03:00
copyright = ' 2019-2021, Proxmox Server Solutions GmbH '
2019-02-27 19:42:31 +03:00
author = ' Proxmox Support Team '
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
2020-07-04 18:51:56 +03:00
vstr = lambda s : ' <devbuild> ' if s is None else str ( s )
version = vstr ( os . getenv ( ' DEB_VERSION_UPSTREAM ' ) )
2019-02-27 19:42:31 +03:00
# The full version, including alpha/beta/rc tags.
2020-07-04 18:51:56 +03:00
release = vstr ( os . getenv ( ' DEB_VERSION ' ) )
2019-02-27 19:42:31 +03:00
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
2020-09-21 19:25:58 +03:00
today_fmt = ' % A, %d % B % Y '
2019-02-27 19:42:31 +03:00
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
2019-02-28 18:28:53 +03:00
exclude_patterns = [
' _build ' , ' Thumbs.db ' , ' .DS_Store ' ,
2021-02-13 12:16:41 +03:00
' */man1.rst ' ,
' config/*/man5.rst ' ,
2019-03-02 12:31:32 +03:00
' epilog.rst ' ,
2019-02-28 18:28:53 +03:00
' pbs-copyright.rst ' ,
2020-07-08 19:15:33 +03:00
' local-zfs.rst '
2019-11-14 13:14:09 +03:00
' package-repositories.rst ' ,
2019-02-28 18:28:53 +03:00
]
2019-02-27 19:42:31 +03:00
# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = ' sphinx '
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
2020-09-11 12:08:59 +03:00
todo_include_todos = not tags . has ( ' release ' )
2019-02-27 19:42:31 +03:00
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
2020-09-11 12:05:41 +03:00
html_theme = ' alabaster '
2019-02-27 19:42:31 +03:00
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
2020-09-11 12:05:41 +03:00
html_theme_options = {
' fixed_sidebar ' : True ,
2020-09-24 20:44:50 +03:00
' sidebar_includehidden ' : False ,
' sidebar_collapse ' : False ,
' globaltoc_collapse ' : False ,
' show_relbar_bottom ' : True ,
2020-09-11 12:05:41 +03:00
' show_powered_by ' : False ,
2020-09-24 20:44:50 +03:00
' extra_nav_links ' : {
' Proxmox Homepage ' : ' https://proxmox.com ' ,
' PDF ' : ' proxmox-backup.pdf ' ,
2021-02-21 11:00:13 +03:00
' API Viewer ' : ' api-viewer/index.html ' ,
2020-11-03 17:28:42 +03:00
' Prune Simulator ' : ' prune-simulator/index.html ' ,
2020-12-19 19:39:48 +03:00
' LTO Barcode Generator ' : ' lto-barcode/index.html ' ,
2020-09-24 20:44:50 +03:00
} ,
2020-09-11 12:05:41 +03:00
2020-09-24 20:44:50 +03:00
' sidebar_width ' : ' 320px ' ,
' page_width ' : ' 1320px ' ,
2020-09-11 12:05:41 +03:00
# font styles
' head_font_family ' : ' Lato, sans-serif ' ,
' caption_font_family ' : ' Lato, sans-serif ' ,
' caption_font_size ' : ' 20px ' ,
' font_family ' : ' Open Sans, sans-serif ' ,
}
2019-02-27 19:42:31 +03:00
2020-09-24 20:40:28 +03:00
# Alabaster theme recommends setting this fixed.
# If you switch theme this needs to removed, probably.
html_sidebars = {
' ** ' : [
' sidebar-header.html ' ,
' searchbox.html ' ,
' navigation.html ' ,
' relations.html ' ,
] ,
' index ' : [
' sidebar-header.html ' ,
' searchbox.html ' ,
' index-sidebar.html ' ,
]
}
2019-02-27 19:42:31 +03:00
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
# html_title = 'Proxmox Backup v1.0-1'
# A shorter title for the navigation bar. Default is the same as html_title.
#
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
2020-09-11 12:05:41 +03:00
#html_logo = 'images/proxmox-logo.svg' # replaced by html_theme_options.logo
2019-02-27 19:42:31 +03:00
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
html_favicon = ' images/favicon.ico '
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = [ ' _static ' ]
2020-11-08 15:28:57 +03:00
html_js_files = [
' custom.js ' ,
]
2019-02-27 19:42:31 +03:00
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None
2021-02-08 13:39:47 +03:00
# We need to disable smatquotes, else Option Lists do not display long options
smartquotes = False
2019-02-27 19:42:31 +03:00
# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}
# If false, no module index is generated.
#
# html_domain_indices = True
# If false, no index is generated.
#
# html_use_index = True
# If true, the index is split into individual pages for each letter.
#
# html_split_index = False
# If true, links to the reST sources are added to the pages.
#
2020-09-11 12:05:41 +03:00
html_show_sourcelink = False
2019-02-27 19:42:31 +03:00
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = ' ProxmoxBackupdoc '
2021-04-05 12:59:43 +03:00
# use local mathjax package, symlink comes from debian/proxmox-backup-docs.links
mathjax_path = " mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML "
2019-02-27 19:42:31 +03:00
# -- Options for LaTeX output ---------------------------------------------
2020-05-03 08:47:03 +03:00
latex_engine = ' xelatex '
2019-02-27 19:42:31 +03:00
latex_elements = {
2020-05-03 08:47:03 +03:00
' fontenc ' : ' \\ usepackage {fontspec} ' ,
2019-02-27 19:42:31 +03:00
# The paper size ('letterpaper' or 'a4paper').
#
' papersize ' : ' a4paper ' ,
# The font size ('10pt', '11pt' or '12pt').
#
2020-05-03 08:47:03 +03:00
' pointsize ' : ' 10pt ' ,
' fontpkg ' : r '''
2020-05-04 11:48:09 +03:00
\setmainfont { Open Sans }
2020-05-04 11:15:27 +03:00
\setsansfont { Lato }
2020-05-04 10:02:10 +03:00
\setmonofont { DejaVu Sans Mono }
2020-05-03 08:47:03 +03:00
''' ,
2019-02-27 19:42:31 +03:00
# Additional stuff for the LaTeX preamble.
#
2020-05-04 10:02:10 +03:00
# 'preamble': '',
2019-02-27 19:42:31 +03:00
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
( master_doc , ' ProxmoxBackup.tex ' , ' Proxmox Backup Documentation ' ,
' Proxmox Support Team ' , ' manual ' ) ,
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
#
# Note: newer sphinx 1.6 should be able to convert .svg to .png
# automatically using sphinx.ext.imgconverter
latex_logo = " images/proxmox-logo.png "
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#
# latex_use_parts = False
# If true, show page references after internal links.
#
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#
# latex_appendices = []
# It false, will not define \strong, \code, itleref, \crossref ... but only
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
# packages.
#
# latex_keep_old_macro_names = True
# If false, no module index is generated.
#
# latex_domain_indices = True
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright
# The basename for the epub file. It defaults to the project name.
# epub_basename = project
# The HTML theme for the epub output. Since the default themes are not
# optimized for small screen space, using the same theme for HTML and epub
# output is usually not wise. This defaults to 'epub', a theme designed to save
# visual space.
#
# epub_theme = 'epub'
# The language of the text. It defaults to the language option
# or 'en' if the language is not set.
#
# epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
# epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
#
# epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#
# epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#
# epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#
# epub_pre_files = []
# HTML files that should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#
# epub_post_files = []
# A list of files that should not be packed into the epub file.
epub_exclude_files = [ ' search.html ' ]
# The depth of the table of contents in toc.ncx.
#
# epub_tocdepth = 3
# Allow duplicate toc entries.
#
# epub_tocdup = True
# Choose between 'default' and 'includehidden'.
#
# epub_tocscope = 'default'
# Fix unsupported image types using the Pillow.
#
# epub_fix_images = False
# Scale large images.
#
# epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# epub_show_urls = 'inline'
# If false, no index is generated.
#
# epub_use_index = True