Compare commits

..

No commits in common. "main" and "auto-version" have entirely different histories.

4 changed files with 8 additions and 28 deletions

View File

@ -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
```
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
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 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.
```
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.
For pdf output the LaTeX builder is used, so `latex` and `pdflatex` need to be installed.
### Running the document generation via make
@ -62,8 +48,3 @@ export SPHINXOPTS="-D version=$(git -C source/handbuch describe --tags --abbrev=
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.
### Clean up
1. Deactivate the virtual Python environment: ```deactivate```
2. Clean up the build sources: ```make clean``` and ```rm -r build bundle```

View File

@ -20,7 +20,7 @@ import sys
# -- Project information -----------------------------------------------------
project = 'RTFM - Das Handbuch zur WTF eG'
copyright = '2021-2023, diverse'
copyright = '2021, diverse'
author = 'Autorenkollektiv'
# The full version, including alpha/beta/rc tags
@ -54,8 +54,6 @@ language = 'de'
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
myst_url_schemes = ['http', 'https', 'mailto', 'ftp', 'mumble']
# -- Options for HTML output -------------------------------------------------

@ -1 +1 @@
Subproject commit 1b1c4bffef881b4eb80956a2755578c17dc615ec
Subproject commit c71746991c32af127f60d60bf7477c891615b7d5

View File

@ -3,20 +3,21 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
RTFM - Das Handbuch zur WTF Kooperative eG
RTFM - Das Handbuch zur wtf Kooperative eG
===========================================
.. toctree::
:maxdepth: 2
:caption: Inhaltsverzeichnis
:caption: Contents:
handbuch/impressum.md
handbuch/intro.md
handbuch/organisation.md
handbuch/Aufnahmeprozess.md
handbuch/Wegweiser.md
handbuch/Business/index.rst
handbuch/Einkaufen-beim-Großhandel.md
handbuch/RaaS.md
handbuch/Auszahlung.md
handbuch/FAQ.md
Indices and tables
==================