docs: add glossary.rst

2019-02-28 19:09:55 +01:00 · 2019-02-28 19:09:55 +01:00 · d823802ea1
commit d823802ea1
parent 541b908ea4
3 changed files with 14 additions and 0 deletions
--- a/docs/glossary.rst
+++ b/docs/glossary.rst
@ -0,0 +1,11 @@
+Glossary
+========
+
+.. glossary::
+
+   Sphinx
+      Sphinx is a tool that makes it easy to create intelligent and beautiful documentation. It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages.
+
+   reStructuredText
+      An easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and
+      parser system.     
--- a/docs/index.rst
+++ b/docs/index.rst
@ -24,6 +24,7 @@ Welcome to Proxmox Backup's documentation!
   :caption: Appendix

   command-syntax.rst
+   glossary.rst
   generated-index.rst
   search-page.rst

--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@ -1,6 +1,8 @@
 Introduction
 ============

+This documentationm is written in :term:`reStructuredText` and formatted with :term:`Sphinx`.
+
 this is a test

 Why Backup?