From a0b8be54785581a9ce551853ed175f88f7210c84 Mon Sep 17 00:00:00 2001 From: Joerg Steffens Date: Wed, 10 Apr 2019 15:23:08 +0200 Subject: [PATCH] docs (Sphinx): cleanup --- .../SpecificFormatting.rst | 45 ++++++++++--------- 1 file changed, 25 insertions(+), 20 deletions(-) diff --git a/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/SpecificFormatting.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/SpecificFormatting.rst index c6d7345e238..c263a1ab2a9 100644 --- a/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/SpecificFormatting.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/SpecificFormatting.rst @@ -1,8 +1,11 @@ Specific Formatting =================== +Configuration +------------- + Configuration File ------------------- +~~~~~~~~~~~~~~~~~~ Configuration file (snippets) should be formatted as @@ -19,8 +22,8 @@ see :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration:B .. seealso:: :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration:Bareos Configuration Resource` -Configuration -~~~~~~~~~~~~~ +Configuration Directive +~~~~~~~~~~~~~~~~~~~~~~~ .. \newcommand{\configline}[1]{\path|#1|} @@ -38,6 +41,25 @@ The output should look like this: However, for a Bareos configuration directive with value use :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration:Resource Directive With Value`\ . +System Command +-------------- + +If only a single command should be shown, or you just want to refer to a system command from the text use: + +.. \newcommand{\command}[1]{\path|#1|} + + Post Conversion Changes: + ${PERL} 's#:raw-latex:`\\command\{(.*?)\}`#:program:`\1`#g' ${DESTFILE} + +:: + + :command:`bareos-dbcheck` + +The output will look like this: + +:command:`bareos-dbcheck` + + Unix Command Session -------------------- @@ -64,23 +86,6 @@ The hostname **host** is used, if it is a generic host. If the command runs on a specific Bareos server, the specific host name from :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosHostNames:Bareos Host Names` should be used. -System Command -~~~~~~~~~~~~~~ - -If only a single command should be shown, or you just want to refer to a system command from the text use: - -.. \newcommand{\command}[1]{\path|#1|} - - Post Conversion Changes: - ${PERL} 's#:raw-latex:`\\command\{(.*?)\}`#:program:`\1`#g' ${DESTFILE} - -:: - - :command:`bareos-dbcheck` - -The output will look like this: - -:command:`bareos-dbcheck` Windows -------