docs (Sphinx): Remove filesystem links from the documentation

... as the documentation build commit "sphinx-versioning" (2.2.1) does not handle links.
Add a note about this to the Style Guide.

docs/manuals/en/new_main_reference/Makefile

@@ -1,10 +1,10 @@
 
 
-GENERATED = autogenerated/bareos-dir-*.rst.inc \
-	autogenerated/bareos-sd-*.rst.inc \
-	autogenerated/bareos-fd-*.rst.inc \
-	autogenerated/bconsole-*.rst.inc \
-	autogenerated/bareos-tray-monitor-*.rst.inc
+GENERATED = include/autogenerated/bareos-dir-*.rst.inc \
+	include/autogenerated/bareos-sd-*.rst.inc \
+	include/autogenerated/bareos-fd-*.rst.inc \
+	include/autogenerated/bconsole-*.rst.inc \
+	include/autogenerated/bareos-tray-monitor-*.rst.inc
 
 GENERATED_RESOURCE_DESCRIPTIONS=../../scripts/generate-resoure-descriptions.py --sphinx
 
@@ -23,23 +23,23 @@ all: sphinx
 
 convert: $(GENERATED) copy pre latexpand split pandoc post1 post2 presphinx sphinx
 
-autogenerated/bareos-dir-*.rst.inc: autogenerated/bareos-dir-config-schema.json
+include/autogenerated/bareos-dir-*.rst.inc: autogenerated/bareos-dir-config-schema.json
 	# generates all director-resource files
 	$(GENERATED_RESOURCE_DESCRIPTIONS) autogenerated/bareos-dir-config-schema.json
 
-autogenerated/bareos-sd-*.rst.inc: autogenerated/bareos-sd-config-schema.json
+include/autogenerated/bareos-sd-*.rst.inc: autogenerated/bareos-sd-config-schema.json
 	# generates all storage daemon resource files
 	$(GENERATED_RESOURCE_DESCRIPTIONS) autogenerated/bareos-sd-config-schema.json
 
-autogenerated/bareos-fd-*.rst.inc: autogenerated/bareos-fd-config-schema.json
+include/autogenerated/bareos-fd-*.rst.inc: autogenerated/bareos-fd-config-schema.json
 	# generates all file daemon resource files
 	$(GENERATED_RESOURCE_DESCRIPTIONS) autogenerated/bareos-fd-config-schema.json
 
-autogenerated/bconsole-*.rst.inc: autogenerated/bconsole-config-schema.json
+include/autogenerated/bconsole-*.rst.inc: autogenerated/bconsole-config-schema.json
 	# generates all bconsole resource files
 	$(GENERATED_RESOURCE_DESCRIPTIONS) autogenerated/bconsole-config-schema.json
 
-autogenerated/bareos-tray-monitor-*.rst.inc: autogenerated/bareos-tray-monitor-config-schema.json
+include/autogenerated/bareos-tray-monitor-*.rst.inc: autogenerated/bareos-tray-monitor-config-schema.json
 	# generates all tray-monitor resource files
 	$(GENERATED_RESOURCE_DESCRIPTIONS) autogenerated/bareos-tray-monitor-config-schema.json
 
@@ -51,8 +51,8 @@ copy:
 	mkdir -p source/include/config/
 	cp -a ../main/*.txt source/include/
 	cp -a ../main/config/*.conf source/include/config/
-	mkdir -p source/autogenerated/
-	cp -a ../main/autogenerated/*-resource-*-description.rst.inc source/autogenerated/
+	mkdir -p source/include/autogenerated/
+	cp -a ../main/autogenerated/*-resource-*-description.rst.inc source/include/autogenerated/
 
 
 pre:

docs/manuals/en/new_main_reference/pre_conversion_changes.sh

@@ -20,7 +20,7 @@ for FILENAME in ${SOURCEFILES}; do
     | perl -0 -pe 's|(\\begin\{document\}).*?(\\part\{Introduction and Tutorial\})|\1\n\n\2|smg' \
     | perl -0 -pe 's|\\part\{Index\}.*?(\\end\{document\})||smg' \
     | perl -pe 's|\\input\{autogenerated/.*-resource-.*-table.tex\}||g' \
-    | perl -pe 's|\\input\{(autogenerated/.*-resource-.*-description).tex\}|\\begin{verbatim}RST:.. include:: /\1.rst.inc\\end{verbatim}|g' \
+    | perl -pe 's|\\input\{(autogenerated/.*-resource-.*-description).tex\}|\\begin{verbatim}RST:.. include:: /include/\1.rst.inc\\end{verbatim}|g' \
     | perl -pe 's#\\begin\{bmessage\}#\\begin{verbatim}\\begin{bmessage}#g' \
     | perl -pe 's#\\end\{bmessage\}#\\end{bmessage}\\end{verbatim}#g' \
 \

docs/manuals/en/new_main_reference/source/Configuration/Console.rst

@@ -50,7 +50,7 @@ The Director resource defines the attributes of the Director running on the netw
 
 
 
-.. include:: /autogenerated/bconsole-resource-director-description.rst.inc
+.. include:: /include/autogenerated/bconsole-resource-director-description.rst.inc
 
 An actual example might be:
 
@@ -129,7 +129,7 @@ Note, the Console resource is optional, but can be useful for restricted console
 
 
 
-.. include:: /autogenerated/bconsole-resource-console-description.rst.inc
+.. include:: /include/autogenerated/bconsole-resource-console-description.rst.inc
 
 Example Console Configuration File
 ----------------------------------

docs/manuals/en/new_main_reference/source/Configuration/Director.rst

@@ -133,7 +133,7 @@ The following is an example of a valid Director resource definition:
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-director-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-director-description.rst.inc
 
 .. _DirectorResourceJob:
 
@@ -321,7 +321,7 @@ definitions (the names must be different, but the contents of the FileSets may b
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-job-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-job-description.rst.inc
 
 The following is an example of a valid Job resource definition:
 
@@ -366,7 +366,7 @@ The Schedule resource provides a means of automatically scheduling a Job as well
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-schedule-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-schedule-description.rst.inc
 
 Note, the Week of Year specification wnn follows the ISO standard definition of the week of the year, where Week 1 is the week in which the first Thursday of the year occurs, or alternatively, the week which contains the 4th of January. Weeks are numbered w01 to w53. w00 for Bareos is the week that precedes the first ISO week (i.e. has the first few days of the year if any occur before Thursday). w00 is not defined by the ISO specification. A week starts with Monday and ends with Sunday.
 
@@ -495,7 +495,7 @@ Any change to the list of the included files will cause Bareos to automatically
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-fileset-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-fileset-description.rst.inc
 
 .. _fileset-include:
 
@@ -2129,7 +2129,7 @@ The Client (or FileDaemon) resource defines the attributes of the Clients that a
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-client-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-client-description.rst.inc
 
 The following is an example of a valid Client resource definition:
 
@@ -2233,7 +2233,7 @@ The Storage resource defines which Storage daemons are available for use by the
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-storage-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-storage-description.rst.inc
 
 The following is an example of a valid Storage resource definition:
 
@@ -2343,7 +2343,7 @@ The Pool Resource defined in the Director’s configuration may contain the foll
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-pool-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-pool-description.rst.inc
 
 The following is an example of a valid Pool resource definition:
 
@@ -2413,7 +2413,7 @@ Since SQLite is compiled in, it always runs on the same machine as the Director
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-catalog-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-catalog-description.rst.inc
 
 The following is an example of a valid Catalog resource definition:
 
@@ -2527,7 +2527,7 @@ The Console resource is optional and need not be specified. The following direct
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-console-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-console-description.rst.inc
 
 The example at :ref:`section-ConsoleAccessExample` shows how to use a console resource for a connection from a client like :command:`bconsole`.
 
@@ -2564,7 +2564,7 @@ The Profile Resource defines a set of ACLs. :ref:`DirectorResourceConsole` can b
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-profile-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-profile-description.rst.inc
 
 .. _DirectorResourceCounter:
 
@@ -2587,7 +2587,7 @@ The Counter Resource defines a counter variable that can be accessed by variable
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-counter-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-counter-description.rst.inc
 
 
 

docs/manuals/en/new_main_reference/source/Configuration/FileDaemon.rst

@@ -110,7 +110,7 @@ Start of the Client records. There must be one and only one Client resource in t
 
 
 
-.. include:: /autogenerated/bareos-fd-resource-client-description.rst.inc
+.. include:: /include/autogenerated/bareos-fd-resource-client-description.rst.inc
 
 The following is an example of a valid Client resource definition:
 
@@ -175,7 +175,7 @@ The Director resource defines the name and password of the Directors that are pe
 
 
 
-.. include:: /autogenerated/bareos-fd-resource-director-description.rst.inc
+.. include:: /include/autogenerated/bareos-fd-resource-director-description.rst.inc
 
 Thus multiple Directors may be authorized to use this Client’s services. Each Director will have a different name, and normally a different password as well.
 

docs/manuals/en/new_main_reference/source/Configuration/Messages.rst

@@ -72,7 +72,7 @@ destination = address = message-type1, message-type2, message-type3, ...
 
 
 
-.. include:: /autogenerated/bareos-dir-resource-messages-description.rst.inc
+.. include:: /include/autogenerated/bareos-dir-resource-messages-description.rst.inc
 
 .. _MessageTypes:
 

docs/manuals/en/new_main_reference/source/Configuration/Monitor.rst

@@ -40,7 +40,7 @@ The Monitor resource defines the attributes of the Monitor running on the networ
 
 
 
-.. include:: /autogenerated/bareos-tray-monitor-resource-monitor-description.rst.inc
+.. include:: /include/autogenerated/bareos-tray-monitor-resource-monitor-description.rst.inc
 
 .. _DirectorResource2:
 
@@ -65,7 +65,7 @@ You may have multiple Director resource specifications in a single Monitor confi
 
 
 
-.. include:: /autogenerated/bareos-tray-monitor-resource-director-description.rst.inc
+.. include:: /include/autogenerated/bareos-tray-monitor-resource-director-description.rst.inc
 
 .. _ClientResource1:
 
@@ -92,7 +92,7 @@ You may have multiple Director resource specifications in a single Monitor confi
 
 
 
-.. include:: /autogenerated/bareos-tray-monitor-resource-client-description.rst.inc
+.. include:: /include/autogenerated/bareos-tray-monitor-resource-client-description.rst.inc
 
 .. _StorageResource1:
 
@@ -123,7 +123,7 @@ You may have multiple Director resource specifications in a single Monitor confi
 
 
 
-.. include:: /autogenerated/bareos-tray-monitor-resource-storage-description.rst.inc
+.. include:: /include/autogenerated/bareos-tray-monitor-resource-storage-description.rst.inc
 
 Tray Monitor
 ------------

docs/manuals/en/new_main_reference/source/Configuration/StorageDaemon.rst

@@ -127,7 +127,7 @@ In general, the properties specified under the Storage resource define global pr
 
 
 
-.. include:: /autogenerated/bareos-sd-resource-storage-description.rst.inc
+.. include:: /include/autogenerated/bareos-sd-resource-storage-description.rst.inc
 
 The following is a typical Storage daemon storage resource definition.
 
@@ -186,7 +186,7 @@ The Director resource specifies the Name of the Director which is permitted to u
 
 
 
-.. include:: /autogenerated/bareos-sd-resource-director-description.rst.inc
+.. include:: /include/autogenerated/bareos-sd-resource-director-description.rst.inc
 
 The following is an example of a valid Director resource definition:
 
@@ -223,7 +223,7 @@ The NDMP Resource specifies the authentication details of each NDMP client. Ther
 
 
 
-.. include:: /autogenerated/bareos-sd-resource-ndmp-description.rst.inc
+.. include:: /include/autogenerated/bareos-sd-resource-ndmp-description.rst.inc
 
 .. _StorageResourceDevice:
 
@@ -366,7 +366,7 @@ The Device Resource specifies the details of each device (normally a tape drive)
 
 
 
-.. include:: /autogenerated/bareos-sd-resource-device-description.rst.inc
+.. include:: /include/autogenerated/bareos-sd-resource-device-description.rst.inc
 
 Edit Codes for Mount and Unmount Directives
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -481,7 +481,7 @@ The Autochanger resource supports single or multiple drive autochangers by group
 
 
 
-.. include:: /autogenerated/bareos-sd-resource-autochanger-description.rst.inc
+.. include:: /include/autogenerated/bareos-sd-resource-autochanger-description.rst.inc
 
 The following is an example of a valid Autochanger resource definition:
 

docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/DocumentFileStructure.rst

@@ -68,3 +68,11 @@ Files included by toctree will be inserted as one section level below the sectio
 
    (Even without changing the file name,
    changing the section name will also break links.)
+
+.. note::
+
+   Do 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.
+   This command however does not handle filesystem links.