From d823802ea1512f156668aa6fda5c95ac8f829adc Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Thu, 28 Feb 2019 19:09:55 +0100 Subject: [PATCH] docs: add glossary.rst --- docs/glossary.rst | 11 +++++++++++ docs/index.rst | 1 + docs/introduction.rst | 2 ++ 3 files changed, 14 insertions(+) create mode 100644 docs/glossary.rst diff --git a/docs/glossary.rst b/docs/glossary.rst new file mode 100644 index 00000000..a3d16c35 --- /dev/null +++ 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. diff --git a/docs/index.rst b/docs/index.rst index 855445f3..068189bc 100644 --- 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 diff --git a/docs/introduction.rst b/docs/introduction.rst index f0d94064..c48ca9d1 100644 --- 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?