forked from gulliver/rtfm
Compare commits
No commits in common. "main" and "build-with-drone" have entirely different histories.
main
...
build-with
@ -32,9 +32,8 @@ steps:
|
|||||||
image: sphinxdoc/sphinx-latexpdf:5.0.2
|
image: sphinxdoc/sphinx-latexpdf:5.0.2
|
||||||
commands:
|
commands:
|
||||||
- apt-get update
|
- apt-get update
|
||||||
- apt-get -y install texlive-lang-german rsync git
|
- apt-get -y install texlive-lang-german rsync
|
||||||
- pip install -r requirements.txt
|
- pip install -r requirements.txt
|
||||||
- export SPHINXOPTS="-D version=$(git -C source/handbuch describe --tags --abbrev=0) -D release=$(git -C source/handbuch describe --tags)"
|
|
||||||
- make -j4 bundle
|
- make -j4 bundle
|
||||||
- name: upload
|
- name: upload
|
||||||
image: alpine
|
image: alpine
|
||||||
@ -45,8 +44,8 @@ steps:
|
|||||||
from_secret: nextcloud_password
|
from_secret: nextcloud_password
|
||||||
commands:
|
commands:
|
||||||
- apk add curl
|
- apk add curl
|
||||||
- curl -X PUT -u $NC_USER:$NC_PASSWORD https://work.wtf-eg.de/remote.php/dav/files/$NC_USER/Dokumentation/Das%20Handbuch%20zur%20WTF%20eG.pdf -T bundle/rtfm-dashandbuchzurwtfeg.pdf
|
- curl -X PUT -u $NC_USER:$NC_PASSWORD https://work.wtf-eg.de/remote.php/dav/files/$NC_USER/Member-Handbuch/Das%20Handbuch%20zur%20WTF%20eG.pdf -T bundle/rtfm-dashandbuchzurwtfeg.pdf
|
||||||
- curl -X PUT -u $NC_USER:$NC_PASSWORD https://work.wtf-eg.de/remote.php/dav/files/$NC_USER/Dokumentation/Das%20Handbuch%20zur%20WTF%20eG.epub -T bundle/RTFM-DasHandbuchzurWTFeG.epub
|
- curl -X PUT -u $NC_USER:$NC_PASSWORD https://work.wtf-eg.de/remote.php/dav/files/$NC_USER/Member-Handbuch/Das%20Handbuch%20zur%20WTF%20eG.epub -T bundle/RTFM-DasHandbuchzurWTFeG.epub
|
||||||
when:
|
when:
|
||||||
branch:
|
branch:
|
||||||
- main
|
- main
|
||||||
@ -56,6 +55,6 @@ steps:
|
|||||||
|
|
||||||
---
|
---
|
||||||
kind: signature
|
kind: signature
|
||||||
hmac: 797e2df88805ae1dee84d60ec024034965dcf41fc2ef86d5667adfdfe10b2719
|
hmac: 84db7299d18047e70a324c4b059f8a2cdd13b497ac439264e4430a37e443c610
|
||||||
|
|
||||||
...
|
...
|
||||||
|
27
README.md
27
README.md
@ -17,14 +17,6 @@ This repository accesses the required WTF handbook's content as a git submodule.
|
|||||||
git clone --recurse-submodules https://git.wtf-eg.de/wtf-eg/handbuch-gen.git
|
git clone --recurse-submodules https://git.wtf-eg.de/wtf-eg/handbuch-gen.git
|
||||||
```
|
```
|
||||||
|
|
||||||
If you cloned this repository initially without submobules, you can always update the content of submodule directories with the git submodule update command. Execute the command from the main project directory:
|
|
||||||
|
|
||||||
```
|
|
||||||
git submodule update --init --recursive
|
|
||||||
```
|
|
||||||
|
|
||||||
The --init flag initializes the submodules before the update. The --recursive option searches for nested submodules and ensures they are updated too.
|
|
||||||
|
|
||||||
### Python based dependencies
|
### Python based dependencies
|
||||||
|
|
||||||
In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
|
In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
|
||||||
@ -37,13 +29,7 @@ In order to generate the documentation, first create a Python 3 virtual environm
|
|||||||
|
|
||||||
For generating the images from PlantUML sources (`*.plantuml`), [PlantUML](https://plantuml.com/) is required.
|
For generating the images from PlantUML sources (`*.plantuml`), [PlantUML](https://plantuml.com/) is required.
|
||||||
|
|
||||||
For pdf output the LaTeX builder is used, so `latex` and `pdflatex` need to be installed. On a clean (no Latex compilation yet) operating system like GNU/Debian, the following dependencies are required to make Latex compile the sources.
|
For pdf output the LaTeX builder is used, so `latex` and `pdflatex` need to be installed.
|
||||||
|
|
||||||
```
|
|
||||||
sudo apt install texlive-base texlive-latex-base texlive-latex-extra texlive-lang-german texlive-fonts-extra --no-install-recommends
|
|
||||||
```
|
|
||||||
|
|
||||||
For document generation `make` and `latexmk` is required.
|
|
||||||
|
|
||||||
### Running the document generation via make
|
### Running the document generation via make
|
||||||
|
|
||||||
@ -53,17 +39,6 @@ The top level directory contains a Makefile, for generation with all output form
|
|||||||
make bundle
|
make bundle
|
||||||
`````
|
`````
|
||||||
|
|
||||||
In order to automatically determine the version string from the latest Git tag, execute the following command before calling `make`:
|
|
||||||
|
|
||||||
```
|
|
||||||
export SPHINXOPTS="-D version=$(git -C source/handbuch describe --tags --abbrev=0) -D release=$(git -C source/handbuch describe --tags)"
|
|
||||||
```
|
|
||||||
|
|
||||||
The output files of the final handbook can be found in the subfolder `./bundle`.
|
The output files of the final handbook can be found in the subfolder `./bundle`.
|
||||||
|
|
||||||
All generated intermediate artifacts and the final output files can be found in the `./build` subfolder.
|
All generated intermediate artifacts and the final output files can be found in the `./build` subfolder.
|
||||||
|
|
||||||
### Clean up
|
|
||||||
|
|
||||||
1. Deactivate the virtual Python environment: ```deactivate```
|
|
||||||
2. Clean up the build sources: ```make clean``` and ```rm -r build bundle```
|
|
||||||
|
@ -20,14 +20,11 @@ import sys
|
|||||||
# -- Project information -----------------------------------------------------
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
project = 'RTFM - Das Handbuch zur WTF eG'
|
project = 'RTFM - Das Handbuch zur WTF eG'
|
||||||
copyright = '2021-2023, diverse'
|
copyright = '2021, diverse'
|
||||||
author = 'Autorenkollektiv'
|
author = 'Autorenkollektiv'
|
||||||
|
|
||||||
# The full version, including alpha/beta/rc tags
|
# The full version, including alpha/beta/rc tags
|
||||||
release = '0.0.0'
|
release = '0.2.0'
|
||||||
|
|
||||||
# The major project version, without alpha/beta/rc tags
|
|
||||||
version = '0.0.0'
|
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
||||||
|
|
||||||
@ -54,8 +51,6 @@ language = 'de'
|
|||||||
# This pattern also affects html_static_path and html_extra_path.
|
# This pattern also affects html_static_path and html_extra_path.
|
||||||
exclude_patterns = []
|
exclude_patterns = []
|
||||||
|
|
||||||
myst_url_schemes = ['http', 'https', 'mailto', 'ftp', 'mumble']
|
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTML output -------------------------------------------------
|
# -- Options for HTML output -------------------------------------------------
|
||||||
|
|
||||||
|
@ -1 +1 @@
|
|||||||
Subproject commit 1b1c4bffef881b4eb80956a2755578c17dc615ec
|
Subproject commit c209afb9e79c4018182af6b59dc926717a563a9b
|
@ -3,20 +3,21 @@
|
|||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
RTFM - Das Handbuch zur WTF Kooperative eG
|
RTFM - Das Handbuch zur wtf Kooperative eG
|
||||||
===========================================
|
===========================================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Inhaltsverzeichnis
|
:caption: Contents:
|
||||||
|
|
||||||
handbuch/impressum.md
|
handbuch/impressum.md
|
||||||
handbuch/intro.md
|
handbuch/intro.md
|
||||||
handbuch/organisation.md
|
handbuch/organisation.md
|
||||||
handbuch/Aufnahmeprozess.md
|
handbuch/Aufnahmeprozess.md
|
||||||
handbuch/Wegweiser.md
|
handbuch/Wegweiser.md
|
||||||
handbuch/Business/index.rst
|
|
||||||
handbuch/Einkaufen-beim-Großhandel.md
|
|
||||||
handbuch/RaaS.md
|
handbuch/RaaS.md
|
||||||
handbuch/Auszahlung.md
|
handbuch/Auszahlung.md
|
||||||
handbuch/FAQ.md
|
handbuch/FAQ.md
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
==================
|
||||||
|
Reference in New Issue
Block a user