doc: automatically convert to sphinx

We now automatically convert the .tex files to sphinx via pandoc. In the .tex files are first adapted so that pandoc can convert them, then the resulting .rst files are adapted to convert what pandoc was not able to.
bareos · Dec 3, 2018 · b1d453c · b1d453c
1 parent 7407178
commit b1d453c
Show file tree

Hide file tree

Showing 77 changed files with 711 additions and 564 deletions.
diff --git a/docs/debian/control b/docs/debian/control
@@ -1,7 +1,7 @@
 Source: bareos-docs
 Priority: extra
 Maintainer: Joerg Steffens <joerg.steffens@bareos.com>
-Build-Depends: bareos-director, bareos-database-sqlite3, bareos-storage, bareos-filedaemon, bareos-bconsole, bareos-traymonitor, debhelper, ghostscript, imagemagick, librsvg2-bin, pandoc, python, texlive-fonts-recommended, texlive-latex-recommended, tex4ht
+Build-Depends: bareos-director, bareos-database-sqlite3, bareos-storage, bareos-filedaemon, bareos-bconsole, bareos-traymonitor, debhelper, ghostscript, imagemagick, librsvg2-bin, pandoc, python, texlive-fonts-recommended, texlive-latex-recommended, tex4ht, perl
 Standards-Version: 3.8.4
 Section: doc
 Vcs-Git: https://github.com/bareos/bareos-docs.git

diff --git a/docs/manuals/en/developers/source/index.rst b/docs/manuals/en/developers/source/index.rst
@@ -15,21 +15,21 @@ Welcome to Bareos Developer Guide's documentation!
    messages.rst
    pluginAPI.rst
    platformsupport.rst
-   daemonprotocol.rst 
+   daemonprotocol.rst
    file.rst
    storage.rst
-   catalog.rst 
+   catalog.rst
    mediaformat.rst
    porting.rst
    api.rst
    tls-techdoc.rst
    regression.rst
-   mempool.rst    
+   mempool.rst
    netprotocol.rst
    directorConsole.rst
    smartall.rst
    fdl.rst
-  
+
 Indices and tables
 ==================
 

diff --git a/docs/manuals/en/main/ansi-labels.tex b/docs/manuals/en/main/ansi-labels.tex
@@ -5,7 +5,7 @@ \section{Tape Labels: ANSI or IBM}
 \index[general]{Tape!Label!ANSI}
 \index[general]{Tape!Label!IBM}
 
-By default, Bareos uses its own tape label (see \nameref{backward-compability-tape-format} and \linkResourceDirective{Dir}{Pool}{Label Type}).
+By default, Bareos uses its own tape label (see \nameref{backward-compatibility-tape-format} and \linkResourceDirective{Dir}{Pool}{Label Type}).
 However, Bareos also supports reading and write ANSI and IBM tape labels.
 
 \subsection{Reading}

diff --git a/.../manuals/en/main/backward-compability.tex → ...anuals/en/main/backward-compatibility.tex b/.../manuals/en/main/backward-compability.tex → ...anuals/en/main/backward-compatibility.tex
@@ -1,13 +1,13 @@
 \chapter{Backward Compatibility}
 \index[general]{Compatibility!Backward}
-\label{backward-compability}
+\label{backward-compatibility}
 
 \section{Tape Formats}
 \index[general]{Tape!Format}
-\label{backward-compability-tape-format}
+\label{backward-compatibility-tape-format}
 
 
-One of the major goals of Backup softare is to ensure that you can restore
+One of the major goals of Backup software is to ensure that you can restore
 tapes (the word tape should also include disk volumes) that you wrote years
 ago.  This means that each new version of the software should be able to read old
 format tapes. The first problem you will have is to ensure that the

diff --git a/docs/manuals/en/main/configure.tex b/docs/manuals/en/main/configure.tex
@@ -401,15 +401,15 @@ \section{Resource}
 A resource is defined as the resource type (see \nameref{ResTypes}),
 followed by an open brace (\path|{|), a number of \nameref{sec:ConfigurationResourceDirective}s, and ended by a closing brace (\path|}|)
 
-\hide{
-\begin{bconfig}{Resource}
-$RESOURCETYPE {
-    Name  = $RESOURCENAME
-    $KEY1 = $VALUE1
-    $KEY2 = $VALUE2
-}
-\end{bconfig}
-}
+% \hide{
+% \begin{bconfig}{Resource}
+% $RESOURCETYPE {
+%     Name  = $RESOURCENAME
+%     $KEY1 = $VALUE1
+%     $KEY2 = $VALUE2
+% }
+% \end{bconfig}
+% }
 
 Each resource definition MUST contain a \configdirective{Name} directive.
 It can contain a \configdirective{Description} directive.

diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex
@@ -396,7 +396,7 @@ \section{Storage Resource}
 Storage {
   Name = DLTDrive
   Address = lpmatou
-  Password = storage_password # password for Storage daemon
+  Password = storage\_password # password for Storage daemon
   Device = "HP DLT 80"    # same as Device in Storage daemon
   Media Type = DLT8000    # same as MediaType in Storage daemon
 }

diff --git a/docs/manuals/en/main/general.tex b/docs/manuals/en/main/general.tex
@@ -27,7 +27,7 @@ \section{History}
 This documentation also bases on the \elink{original Bacula documentation}{http://www.bacula.org/5.2.x-manuals/en/main/main/}, it is technically
 also a fork of the documenation created following the rules of the GNU Free Documentation License.
 
-Original author of Bacula and it's documentation is Kern Sibbald. We thank Kern and all contributors to Bacula and it's documentation.
+Original author of Bacula and its documentation is Kern Sibbald. We thank Kern and all contributors to Bacula and it's documentation.
 We maintain a list of contributors to Bacula (until the time we've started the fork) and Bareos in our \elink{AUTHORS}{https://github.com/bareos/bareos/blob/master/AUTHORS} file.
 
 
@@ -503,8 +503,8 @@ \section{Terminology}
    easily restored.  This function is particularly useful if certain
    Volumes or Jobs have exceeded their retention period and have been
    pruned or purged from the Catalog.  Scanning data from Volumes into the
-   Catalog is done by using the {\bf bscan} program.  See the \ilink{bscan
-   section}{bscan} of the Bareos Utilities chapter of this manual for more
+   Catalog is done by using the {\bf bscan} program.  See the \ilink{bscan section}{bscan}
+   of the Bareos Utilities chapter of this manual for more
    details.
 
 \item [Volume]

diff --git a/docs/manuals/en/main/storedconf.tex b/docs/manuals/en/main/storedconf.tex
@@ -98,7 +98,7 @@ \section{Director Resource}
 \begin{bconfig}{Storage daemon Director definition}
 Director {
   Name = MainDirector
-  Password = my_secret_password
+  Password = my\_secret\_password
 }
 \end{bconfig}