forked from wtf-eg/handbuch-gen
Compare commits
25 Commits
auto-versi
...
main
Author | SHA1 | Date | |
---|---|---|---|
e0255ad1bc | |||
70faa0dbb2 | |||
847c227765 | |||
b98a19b955 | |||
0c48ee0210 | |||
bc4d3f8249 | |||
222ad0244b | |||
f74933d864 | |||
ab3190dcf1 | |||
30ae14dde1 | |||
b67f892ed5 | |||
f03e5d87eb | |||
5334bf19bd | |||
a65ea359d5 | |||
27ec529d4a | |||
7d190dd4ad | |||
|
c49ddb0749 | ||
b8b9be9891 | |||
2265935bd6 | |||
3414b67e58 | |||
8d6ee6f776 | |||
0474d264b5 | |||
3b6161d64a | |||
4688bc13ae | |||
fcc741b909 |
21
README.md
21
README.md
@ -17,6 +17,14 @@ 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:
|
||||
@ -29,7 +37,13 @@ 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.
|
||||
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.
|
||||
|
||||
### Running the document generation via make
|
||||
|
||||
@ -48,3 +62,8 @@ 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```
|
||||
|
@ -20,7 +20,7 @@ import sys
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'RTFM - Das Handbuch zur WTF eG'
|
||||
copyright = '2021, diverse'
|
||||
copyright = '2021-2023, diverse'
|
||||
author = 'Autorenkollektiv'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
@ -54,6 +54,8 @@ 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 c71746991c32af127f60d60bf7477c891615b7d5
|
||||
Subproject commit 1b1c4bffef881b4eb80956a2755578c17dc615ec
|
@ -3,21 +3,20 @@
|
||||
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: Contents:
|
||||
:caption: Inhaltsverzeichnis
|
||||
|
||||
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
|
||||
==================
|
||||
|
Loading…
Reference in New Issue
Block a user