feat: work on beamer slides

.drone.yml

@@ -17,6 +17,7 @@ steps:
       - apt-get -y install texlive-lang-german
       - pip install -r requirements.txt
       - make latexpdf
+      - make html
 
 ---
 kind: pipeline
@@ -34,10 +35,24 @@ steps:
       - apt-get -y install texlive-lang-german
       - pip install -r requirements.txt
       - make latexpdf
+      - make html
   - name: gitea_release
     image: plugins/gitea-release
     settings:
       api_key:
         from_secret: gitea_token
       base_url: https://git.wtf-eg.de
-      files: build/latex/rtfm-dashandbuchderfreefederatedfleetfffleetinitiative.pdf
+      files: build/latex/rtfm-dashandbuchderfreefederatedfleetinitiative.pdf
+  - name: html
+    image: cschlosser/drone-ftps
+    environment:
+      FTP_USERNAME:
+        from_secret: username
+      FTP_PASSWORD:
+        from_secret: password
+      PLUGIN_HOSTNAME:
+        from_secret: hostname
+      PLUGIN_SRC_DIR: /build/html
+      PLUGIN_DEST_DIR: /home/pacs/sib00/users/swingbe_fffleet/doms/fffleet.swingbe.de/subs-ssl/www
+      PLUGIN_MIRROR_OPTS: -e
+      PLUGIN_CLEAN_DIR: false

.gitignore

@@ -1,3 +1,5 @@
+bundle
 build
 venv
 *.*~
+*~

makefile

@@ -16,5 +16,19 @@ help:
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
+%: makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: sphinx bundle
+
+clean:
+	-rm -rf build
+	-rm -rf bundle
+
+sphinx:
+	$(MAKE) singlehtml latexpdf
+
+bundle: sphinx
+	-mkdir bundle
+	cp build/latex/*.pdf bundle/
+	rsync -av --delete build/singlehtml/ bundle/html

readme.md

@@ -1,3 +1,7 @@
+# General
+
+[![Build Status](https://drone.wtf-eg.de/api/badges/FreeFleetManagement/manual/status.svg)](https://drone.wtf-eg.de/FreeFleetManagement/manual)
+
 # Introduction
 
 Call ```sphinx-quickstart``` to setup the project.
@@ -59,15 +63,20 @@ The output files of the final handbook can be found in the subfolder `./build`.
 
 All generated intermediate artifacts and the final output files can be found in the `./build` subfolder.
 
+Generate all output like this.
+
+```
+make bundle
+```
+
 ### Clean up
 
 1. Deactivate the virtual Python environment: ```deactivate```
-2. Clean up the build sources: ```make clean``` and ```rm -r build bundle```
+2. Clean up the build sources: ```make clean```
 
 # File System
 
 * `build`: build directory
-* `make.bat`:
+* `Makefile`: build configuration
-* `Makefile`:
 * `readme.md`: this file
 * `source`: source directory

requirements.txt

@@ -1 +1,2 @@
 myst-parser
+sphinxcontrib-beamer

source/conf.py

@@ -17,12 +17,12 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'RTFM - Das Handbuch der Free Federated Fleet (FFFleet) Initiative'
+project = 'RTFM - Das Handbuch der Free Federated Fleet Initiative'
 copyright = '2022, <tdb>'
 author = 'Software Ingenieur Begerad (SIB)'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.0'
+release = '0.1.2'
 
 
 # -- General configuration ---------------------------------------------------
@@ -31,7 +31,8 @@ release = '0.1.0'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'myst_parser'
+    'myst_parser',
+    'sphinxcontrib.beamer'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

source/index.rst

@@ -14,6 +14,7 @@ RTFM - Das Handbuch der Free Federated Fleet (FFFleet) Initiative
    manual/open-issues
    manual/requirements
    manual/introduction
+   manual/architecture
    manual/components
    manual/research
 

source/manual/architecture.md

@@ -0,0 +1,15 @@
+# Architektur
+
+//TODO tbc
+
+## Systemumgebung
+
+//TODO tbc
+
+## Systemkontext
+
+//TODO tbc
+
+## Systembeschreibung
+
+//TODO tbc