proxmox-backup/docs/index.rst

.. Proxmox Backup documentation master file

Welcome to the Proxmox Backup documentation!
============================================
| Copyright (C) 2019-2020 Proxmox Server Solutions GmbH
| Version |version| -- |today|

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.3 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".


.. only:: html

 A `PDF` version of the documentation is `also available here <./proxmox-backup.pdf>`_

.. toctree::
   :maxdepth: 3
   :caption: Table of Contents

   introduction.rst
   installation.rst
   terminology.rst
   gui.rst
   storage.rst
   network-management.rst
   user-management.rst
   managing-remotes.rst
   maintenance.rst
   backup-client.rst
   pve-integration.rst
   pxar-tool.rst
   sysadmin.rst
   faq.rst

.. raw:: latex

   \appendix

.. toctree::
   :maxdepth: 2
   :caption: Appendix

   command-syntax.rst
   file-formats.rst
   backup-protocol.rst
   calendarevents.rst
   glossary.rst
   GFDL.rst

.. only:: html and devbuild

    .. toctree::
       :maxdepth: 2
       :hidden:
       :caption: Developer Appendix

       todos.rst


.. # * :ref:`genindex`
docs/index.rst: cleanup 2019-03-19 14:22:17 +03:00			`.. Proxmox Backup documentation master file`
build doc with sphinx 2019-02-27 19:42:31 +03:00
docs: fix index title Contributed-by: Daniela Häsler <daniela@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2020-07-03 19:57:01 +03:00			`Welcome to the Proxmox Backup documentation!`
			`============================================`
docs: add version and date to HTML index Similar to the PDF output or the Proxmox VE docs. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2020-09-21 19:25:58 +03:00			`\| Copyright (C) 2019-2020 Proxmox Server Solutions GmbH`
			`\| Version \|version\| -- \|today\|`
add license for docs (GFDL) 2019-11-11 21:45:44 +03:00
docs: fix index title Contributed-by: Daniela Häsler <daniela@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2020-07-03 19:57:01 +03:00			`Permission is granted to copy, distribute and/or modify this document under the`
			`terms of the GNU Free Documentation License, Version 1.3 or any later version`
			`published by the Free Software Foundation; with no Invariant Sections, no`
			`Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included`
			`in the section entitled "GNU Free Documentation License".`
add license for docs (GFDL) 2019-11-11 21:45:44 +03:00
docs: enable sphinx todo items 2019-11-16 13:16:04 +03:00
docs: reference PDF variant in HTML output Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2020-07-09 22:31:32 +03:00			`.. only:: html`

			A `PDF` version of the documentation is `also available here <./proxmox-backup.pdf>`_

build doc with sphinx 2019-02-27 19:42:31 +03:00			`.. toctree::`
			`:maxdepth: 3`
			`:caption: Table of Contents`

docs: improve ducument structure 2019-02-27 20:35:05 +03:00			`introduction.rst`
			`installation.rst`
Restructure docs (more first level headings) This removes the "Backup Management" first level heading in the docs, and either uses the sub headings contained within it as first level headings, or groups previous sections logically under new headings. The administration-guide.rst file is also removed. Its contents are instead separated into various files, that relate to their respective first level heading. Signed-off-by: Dylan Whyte <d.whyte@proxmox.com> 2020-10-02 17:12:57 +03:00			`terminology.rst`
			`gui.rst`
			`storage.rst`
			`network-management.rst`
			`user-management.rst`
			`managing-remotes.rst`
			`maintenance.rst`
			`backup-client.rst`
			`pve-integration.rst`
			`pxar-tool.rst`
docs: move host sysadmin out to own chapter, fix ZFS one Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2020-07-08 19:15:33 +03:00			`sysadmin.rst`
Add section "FAQ" Adds an FAQ to the docs, based on question that have been appearing on the forum. Signed-off-by: Dylan Whyte <d.whyte@proxmox.com> 2020-09-10 12:05:00 +03:00			`faq.rst`
docs: add sysadmin.rst, cleanups 2019-11-15 15:24:45 +03:00
build doc with sphinx 2019-02-27 19:42:31 +03:00			`.. raw:: latex`

			`\appendix`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Appendix`

			`command-syntax.rst`
start file format docu 2019-03-16 18:44:45 +03:00			`file-formats.rst`
docs/backup-protocol.rst: add backup protocol docs 2019-06-04 18:33:12 +03:00			`backup-protocol.rst`
docs: add section for calendar events and move the info defined in 'Schedules' there, the explanation of calendar events is inspired by the systemd.time manpage and the pve docs (especially the examples are mostly copied/adapted from there) Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> 2020-09-11 11:35:27 +03:00			`calendarevents.rst`
docs: add glossary.rst 2019-02-28 21:09:55 +03:00			`glossary.rst`
add license for docs (GFDL) 2019-11-11 21:45:44 +03:00			`GFDL.rst`
docs: remove generated-index.rst and search-page.rst This does not work as expected. 2019-03-05 20:36:22 +03:00
docs: move todolist to own document, don't link in release build It is always build for html, but not linked if the devbuild tag isn't set. This tag is set in the Makefile if the $(BUILD_MODE) variable isn't "release". Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2020-07-06 15:40:58 +03:00			`.. only:: html and devbuild`

			`.. toctree::`
			`:maxdepth: 2`
docs: index: hide todo list toctree and genindex I do not found another way to disable inclusion in the sidebar... The genindex information is alredy provided through glossary Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2020-09-24 20:42:26 +03:00			`:hidden:`
docs: move todolist to own document, don't link in release build It is always build for html, but not linked if the devbuild tag isn't set. This tag is set in the Makefile if the $(BUILD_MODE) variable isn't "release". Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2020-07-06 15:40:58 +03:00			`:caption: Developer Appendix`

			`todos.rst`


docs: index: hide todo list toctree and genindex I do not found another way to disable inclusion in the sidebar... The genindex information is alredy provided through glossary Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2020-09-24 20:42:26 +03:00			.. # * :ref:`genindex`