docs (Sphinx): fixes

bareos · Apr 11, 2019 · cf32f8a · cf32f8a
1 parent 3fa87a7
commit cf32f8a
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 18 deletions.
diff --git a/...source/DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration.rst b/...source/DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration.rst
@@ -88,7 +88,7 @@ Resource Directive
 Resource Directive Definition
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The documenation outline for resource directives is autogenerated (by https://github.com/bareos/bareos/blob/master/docs/manuals/scripts/generate-resoure-descriptions.py) and stored into the https://github.com/bareos/bareos/tree/master/docs/manuals/en/new_main_reference/source/autogenerated directory.
+The documenation outline for resource directives is autogenerated (by https://github.com/bareos/bareos/blob/master/docs/manuals/scripts/generate-resoure-descriptions.py) and stored into the https://github.com/bareos/bareos/tree/master/docs/manuals/en/new_main_reference/source/include/autogenerated/ directory.
 
 Internally, they can be referenced by the ``:config:option:`` directive.
 From extern, the URL to access them is

diff --git a/...urce/DocumentationStyleGuide/BareosSpecificFormatting/DocumentFileStructure.rst b/...urce/DocumentationStyleGuide/BareosSpecificFormatting/DocumentFileStructure.rst
@@ -71,7 +71,7 @@ Files included by toctree will be inserted as one section level below the sectio
 
 .. note::
 
-   Do use filesystem links in the documentation.
+   Do not use filesystem links in the documentation.
 
    The Bareos documentation is not generated by the normal :command:`sphinx-build` command,
    but by the :command:`sphinx-versioning` (2.2.1) command.

diff --git a/...n_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Release.rst b/...n_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Release.rst
@@ -1,8 +1,8 @@
 Releases
 ========
 
-Functinal Changes
------------------
+Functional Changes
+------------------
 
 If the documenation wants to point out,
 that a feature has been added

diff --git a/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/CommonNames.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/CommonNames.rst
@@ -82,4 +82,4 @@ Products
    reST,         reST
    |sqlite|,     ``|sqlite|``
    |vmware|,     ``|vmware|``
-   |vSphere|,    ``|vSphere|``
+   |vsphere|,    ``|vsphere|``
diff --git a/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/RestOverview.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/RestOverview.rst
@@ -473,7 +473,7 @@ If you want to display a note, the following formatting should be used::
 
    .. note::
 
-   It is important to ...
+      It is important to ...
 
 The output should look like this:
 
@@ -495,11 +495,11 @@ If you want to display a warning, the following formatting should be used:
    ${PERL0} 's#:raw-latex:`\\warning\{(.*?)\}`#\n.. warning:: \n  \1#ims' ${DESTFILE}
    ${PERL0} 's#\\warning\{(.*?)\}#\n.. warning:: \n  \1#ims'  ${DESTFILE}
 
-.. code-block:: sh
+::
 
    .. warning::
 
-   This record ignores retention periods!
+      This record ignores retention periods!
 
 The output should look like this:
 
@@ -624,23 +624,19 @@ Neither of ``.. index::`` nor ``:index:`` correspond well to a Latex ``\index``\
 
 A Latex index will not be printed and the index will refer to the exact location.
 In the Latex documentation indices have also been used inside of other structures (e.g. tables),
-which prevents an easy automatic convertation to ``.. index::``.
+which prevents an easy automatic conversation to ``.. index::``.
 
 To work around these problem, following substitution have been used::
 
   \index{Console!Command!restore}
   
-is substitted by::
-
-  :index:`[TAG=Console->Command->restore] <single: Console; Command; restore>`
+is substituted by::
 
-Disadvantages:
-   The text ``[TAG=Console->Command->restore]`` will be shown.
+  :index:`\ <single: Console; Command; restore>`
 
+The backslash + space sequence create a invisible string.
 When the Sphinx Bareos Manual is edited manually,
-these ''TAGs'' can be replaced to some better fitting indices.
-
-Note: ``triple`` is not required. The original behavior would be more like ``single``. However, we used triple to use some of the Sphinx advantages.
+these entries can be replaced to some better fitting indices.
 
 
 Image
@@ -661,6 +657,6 @@ In general, images should be stored as SVG.
 Table
 -----
 
-Sphinx offeres multiple methods to create tables, see https://www.sphinx-doc.org/en/2.0/usage/restructuredtext/basics.html#tables\ .
+Sphinx offers multiple methods to create tables, see https://www.sphinx-doc.org/en/2.0/usage/restructuredtext/basics.html#tables\ .
 
 Choose whatever sucks least.