tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
proxmox-backup/docs/index.rst

64 lines
1.4 KiB
ReStructuredText
Raw Normal View History

docs/index.rst: cleanup
2019-03-19 11:22:17 +00:00
.. Proxmox Backup documentation master file
build doc with sphinx
2019-02-27 16:42:31 +00: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 16:57:01 +00: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 16:25:58 +00:00
| Copyright (C) 2019-2020 Proxmox Server Solutions GmbH
| Version |version| -- |today|
add license for docs (GFDL)
2019-11-11 18:45:44 +00: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 16:57:01 +00: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 18:45:44 +00:00
docs: enable sphinx todo items
2019-11-16 10:16:04 +00:00
docs: reference PDF variant in HTML output Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-09 19:31:32 +00:00
.. only:: html
A `PDF` version of the documentation is `also available here <./proxmox-backup.pdf>`_
build doc with sphinx
2019-02-27 16:42:31 +00:00
.. toctree::
:maxdepth: 3
:caption: Table of Contents
docs: improve ducument structure
2019-02-27 17:35:05 +00: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 14:12:57 +00: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 16:15:33 +00: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 09:05:00 +00:00
faq.rst
docs: add sysadmin.rst, cleanups
2019-11-15 12:24:45 +00:00
build doc with sphinx
2019-02-27 16:42:31 +00:00
.. raw:: latex
\appendix
.. toctree::
:maxdepth: 2
:caption: Appendix
command-syntax.rst
start file format docu
2019-03-16 15:44:45 +00:00
file-formats.rst
docs/backup-protocol.rst: add backup protocol docs
2019-06-04 15:33:12 +00: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 08:35:27 +00:00
calendarevents.rst
docs: add glossary.rst
2019-02-28 18:09:55 +00:00
glossary.rst
add license for docs (GFDL)
2019-11-11 18:45:44 +00:00
GFDL.rst
docs: remove generated-index.rst and search-page.rst This does not work as expected.
2019-03-05 17:36:22 +00: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 12:40:58 +00: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 17:42:26 +00: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 12:40:58 +00: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 17:42:26 +00:00
.. # * :ref:`genindex`