diff --git a/debian/control b/debian/control index f7f3a941..c7e770b7 100644 --- a/debian/control +++ b/debian/control @@ -5,6 +5,7 @@ Maintainer: Proxmox Support Team Build-Depends: bash-completion, debhelper (>= 10), python3-docutils, + python3-sphinx, liblz4-dev, libpam0g-dev, pkg-config, diff --git a/docs/Makefile b/docs/Makefile index a60973c9..23bd5a30 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -6,18 +6,59 @@ else COMPILEDIR := ../target/debug endif -##UNITS:= proxmox-backup-client +GENERATED_SYNOPSIS := \ + proxmox-backup-client/synopsis.rst -proxmox-backup-client.1: proxmox-backup-client/man1.rst proxmox-backup-client/description.rst ${COMPILEDIR}/proxmox-backup-client +MANUAL_PAGES := \ + proxmox-backup-client.1 + + +# Sphinx documentation setup +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = output + +# Sphinx internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +all: ${MANUAL_PAGES} + +# Build manual pages using rst2man + +proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client ${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst + + +proxmox-backup-client.1: proxmox-backup-client/man1.rst proxmox-backup-client/description.rst proxmox-backup-client/synopsis.rst rst2man $< >$@ -all: proxmox-backup-client.1 +.PHONY: html +html: ${GENERATED_SYNOPSIS} + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." clean: - rm -f *.1 */synopsis.rst + rm -r -f *~ *.1 */synopsis.rst ${BUILDDIR} -install: proxmox-backup-client.1 +install: ${MANUAL_PAGES} install -dm755 $(DESTDIR)$(MAN1DIR) install -m755 proxmox-backup-client.1 $(DESTDIR)$(MAN1DIR)/ diff --git a/docs/command-line-tools.rst b/docs/command-line-tools.rst new file mode 100644 index 00000000..0e925e9a --- /dev/null +++ b/docs/command-line-tools.rst @@ -0,0 +1,8 @@ +Command Line Tools +================== + +``proxmox-backup-client`` +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. include:: proxmox-backup-client/description.rst + diff --git a/docs/command-syntax.rst b/docs/command-syntax.rst new file mode 100644 index 00000000..a7eb7b5d --- /dev/null +++ b/docs/command-syntax.rst @@ -0,0 +1,8 @@ +Command Syntax +============== + +``proxmox-backup-client`` +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. include:: proxmox-backup-client/synopsis.rst + diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..ef4c4819 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,385 @@ +#!/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. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +# -- 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. +extensions = [] + +# 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' + +# General information about the project. +project = 'Proxmox Backup' +copyright = '2019, Proxmox Support Team' +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. +version = '1.0' +# The full version, including alpha/beta/rc tags. +release = '1.0-1' + +# 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. +# +# today_fmt = '%B %d, %Y' + +# 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 +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# 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. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinxdoc' + +# 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. +# +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. +# " v 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. +# +html_logo = 'images/proxmox-logo.svg' + +# 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'] + +# 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 + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# 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. +# +# html_show_sourcelink = True + +# 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 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' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + 'papersize': 'a4paper', + + # The font size ('10pt', '11pt' or '12pt'). + # + 'pointsize': '12pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # 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 diff --git a/docs/generated-index.rst b/docs/generated-index.rst new file mode 100644 index 00000000..6594822a --- /dev/null +++ b/docs/generated-index.rst @@ -0,0 +1,4 @@ +Index +----- + +`genindex` diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico new file mode 100755 index 00000000..ba0c9af6 Binary files /dev/null and b/docs/images/favicon.ico differ diff --git a/docs/images/proxmox-logo.png b/docs/images/proxmox-logo.png new file mode 100644 index 00000000..659793ad Binary files /dev/null and b/docs/images/proxmox-logo.png differ diff --git a/docs/images/proxmox-logo.svg b/docs/images/proxmox-logo.svg new file mode 100644 index 00000000..bc5d22af --- /dev/null +++ b/docs/images/proxmox-logo.svg @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..e197745c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,28 @@ +.. Proxmox Backup documentation master file, created by + sphinx-quickstart on Tue Feb 26 16:54:35 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Proxmox Backup's documentation! +========================================== + +.. toctree:: + :maxdepth: 3 + :caption: Table of Contents + + section1.rst + section2.rst + command-line-tools.rst + +.. raw:: latex + + \appendix + +.. toctree:: + :maxdepth: 2 + :caption: Appendix + + command-syntax.rst + generated-index.rst + search-page.rst + diff --git a/docs/proxmox-backup-client/man1.rst b/docs/proxmox-backup-client/man1.rst index 5734c894..643a2621 100644 --- a/docs/proxmox-backup-client/man1.rst +++ b/docs/proxmox-backup-client/man1.rst @@ -1,3 +1,5 @@ +:orphan: + ========================== proxmox-backup-client ========================== diff --git a/docs/proxmox-backup.rst b/docs/proxmox-backup.rst deleted file mode 100644 index 463a5b1c..00000000 --- a/docs/proxmox-backup.rst +++ /dev/null @@ -1,30 +0,0 @@ -############## -Proxmox Backup -############## - ----------------------------------------------------- -Efficient Backups for Virtual Machines and Container ----------------------------------------------------- - -:Author: Proxmox Support Team - -Backup Server -============= - - -.. NOTE:: - - This is just a test - - -.. WARNING:: This is just a test - - - -Command Line Tools -================== - -``proxmox-backup-client`` -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. include:: proxmox-backup-client/description.rst diff --git a/docs/search-page.rst b/docs/search-page.rst new file mode 100644 index 00000000..d2bd4a10 --- /dev/null +++ b/docs/search-page.rst @@ -0,0 +1,4 @@ +Search Page +----------- + +`search` diff --git a/docs/section1.rst b/docs/section1.rst new file mode 100644 index 00000000..723d5038 --- /dev/null +++ b/docs/section1.rst @@ -0,0 +1,10 @@ +This is Section1 +---------------- + +this is a test + +Sub header +^^^^^^^^^^ + +dfgfd fghfgh fh + diff --git a/docs/section2.rst b/docs/section2.rst new file mode 100644 index 00000000..c7440080 --- /dev/null +++ b/docs/section2.rst @@ -0,0 +1,8 @@ +A test +====== + +sdfsd dfgfd dgd + +This aasd safd +-------------- +