docs: add epilog.rst to define common things.

This commit is contained in:
Dietmar Maurer 2019-03-02 10:31:32 +01:00
parent e909522f06
commit 3147e56a74
4 changed files with 55 additions and 4 deletions

View File

@ -48,6 +48,9 @@ source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
epilog_file = open('epilog.rst', 'r')
rst_epilog = epilog_file.read()
# General information about the project.
project = 'Proxmox Backup'
copyright = '2019, Proxmox Support Team'
@ -84,6 +87,7 @@ language = None
exclude_patterns = [
'_build', 'Thumbs.db', '.DS_Store',
'proxmox-backup-client/man1.rst',
'epilog.rst',
'pbs-copyright.rst',
]

11
docs/epilog.rst Normal file
View File

@ -0,0 +1,11 @@
.. Epilog (included at top of each file)
We use this file to define external links and commone replacement
patterns.
.. _Container: https://en.wikipedia.org/wiki/Container_(virtualization)
.. _Proxmox Virtual Environment: https://www.proxmox.com/proxmox-ve
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
.. _Rust: https://www.rust-lang.org/
.. _Sphinx: https://www.sphinx-doc.org
.. _Virtual machine: https://en.wikipedia.org/wiki/Virtual_machine

View File

@ -3,6 +3,24 @@ Glossary
.. glossary::
`Virtual machine`_
A Virtual machine is a program that can execute an entire
operatin system inside an emulated hardware environment.
`Container`_
A Container is an isolated user space. Programs runs directly on
the hosts kernel, but with limited access to the host resources.
`Rust`_
Rust is a new, fast and memory-efficient system programming
language, with no runtime or garbage collector. Rusts rich type
system and ownership model guarantee memory-safety and
thread-safety. I can eliminate many classes of bugs
at compile-time.
`Sphinx`_
Is a tool that makes it easy to create intelligent and
@ -16,7 +34,3 @@ Glossary
Is an easy-to-read, what-you-see-is-what-you-get plaintext
markup syntax and parser system.
.. _Sphinx: https://www.sphinx-doc.org
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html

View File

@ -11,6 +11,28 @@ Why Backup?
dfgfd fghfgh fh
Features
--------
:Proxmox VE: The `Proxmox Virtual Environment`_ is fully
supported. You can backup :term:`virtual machine`\ s and
:term:`container`\ s.
:GUI: We provide a graphical, web based user interface.
:Deduplication: Inkremental backup produces large amounts of duplicate
data. The deduplication layer removes that redundancy and makes
inkremental backup small and space efficient.
:Remote Sync: It is possible to efficently synchronize data to remote
sites. Only deltas containing new data are transfered.
:Performance: The whole software stack is written in :term:`Rust`,
which provides high speed and memory efficiency.
:Open Source: No secrets. You have access to the whole source tree.
History
-------