Compare commits
15 Commits
drone-sphi
...
dev
Author | SHA1 | Date | |
---|---|---|---|
00e883e3eb | |||
ad82b49371 | |||
f7a5f5e077 | |||
bafb7a96aa | |||
2758e95bc5 | |||
cad768627f | |||
8129187bd9 | |||
1e08ba5b73 | |||
f5e9615799 | |||
616f2d7dcc | |||
b38807c62a | |||
72d0012f33
|
|||
431607c6e5 | |||
64b7c3eaeb | |||
77473030b5 |
65
.drone.yml
65
.drone.yml
@ -1,11 +1,6 @@
|
||||
---
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: amd64-main
|
||||
|
||||
platform:
|
||||
os: linux
|
||||
arch: amd64
|
||||
name: default
|
||||
|
||||
trigger:
|
||||
branch:
|
||||
@ -19,27 +14,45 @@ steps:
|
||||
image: sphinxdoc/sphinx-latexpdf:5.0.2
|
||||
commands:
|
||||
- apt-get update
|
||||
- apt-get -y install texlive-lang-german rsync
|
||||
- apt-get -y install texlive-lang-german
|
||||
- pip install -r requirements.txt
|
||||
- make -j4 latexpdf
|
||||
- name: upload
|
||||
image: alpine
|
||||
environment:
|
||||
NC_USER:
|
||||
from_secret: nextcoud_user
|
||||
NC_PASSWORD:
|
||||
from_secret: nextcloud_password
|
||||
commands:
|
||||
- apt add curl
|
||||
- curl -X PUT -u $NC_USER:$NC_PASSWORD https://work.wtf-eg.de/remote.php/dav/files/$NC_USER/FreeFleetManagement/FFFleet%20Handbuch.pdf -T bundle/latex/rtfm-dashandbuchderfreefederatedfleetfffleetinitiative.pdf
|
||||
when:
|
||||
branch:
|
||||
- main
|
||||
event:
|
||||
- push
|
||||
- make latexpdf
|
||||
- make html
|
||||
|
||||
---
|
||||
kind: signature
|
||||
hmac: 7225cd21b9a1284bba09bd0f943e5873865f176e1dca49147ea8e309421e6726
|
||||
kind: pipeline
|
||||
name: publish
|
||||
|
||||
...
|
||||
trigger:
|
||||
event:
|
||||
- tag
|
||||
|
||||
steps:
|
||||
- name: build
|
||||
image: sphinxdoc/sphinx-latexpdf:5.0.2
|
||||
commands:
|
||||
- apt-get update
|
||||
- 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-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
|
||||
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,3 +1,5 @@
|
||||
bundle
|
||||
build
|
||||
venv
|
||||
*.*~
|
||||
*~
|
@ -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
|
15
readme.md
15
readme.md
@ -1,3 +1,7 @@
|
||||
# General
|
||||
|
||||
[](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`:
|
||||
* `Makefile`: build configuration
|
||||
* `readme.md`: this file
|
||||
* `source`: source directory
|
||||
|
@ -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 ---------------------------------------------------
|
||||
|
@ -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
|
||||
|
||||
|
15
source/manual/architecture.md
Normal file
15
source/manual/architecture.md
Normal file
@ -0,0 +1,15 @@
|
||||
# Architektur
|
||||
|
||||
//TODO tbc
|
||||
|
||||
## Systemumgebung
|
||||
|
||||
//TODO tbc
|
||||
|
||||
## Systemkontext
|
||||
|
||||
//TODO tbc
|
||||
|
||||
## Systembeschreibung
|
||||
|
||||
//TODO tbc
|
Reference in New Issue
Block a user