Compare commits

...

25 Commits

Author SHA1 Message Date
e0255ad1bc Merge pull request 'Release v0.4.1' (#20) from release-0.4.1 into main
All checks were successful
continuous-integration/drone/push Build is passing
Reviewed-on: wtf-eg/handbuch-gen#20
2023-04-12 20:31:36 +02:00
70faa0dbb2
Update sources
All checks were successful
continuous-integration/drone/pr Build is passing
2023-04-12 20:28:56 +02:00
847c227765
Release v0.4.0
All checks were successful
continuous-integration/drone/push Build is passing
2023-02-06 13:00:50 +01:00
b98a19b955
Update sources
All checks were successful
continuous-integration/drone/push Build is passing
2023-01-12 20:36:43 +01:00
0c48ee0210
Update copyright 2023-01-12 20:10:30 +01:00
bc4d3f8249
Cleanup 2023-01-12 20:04:03 +01:00
222ad0244b
Extend copyright
All checks were successful
continuous-integration/drone/push Build is passing
2022-12-01 13:55:04 +01:00
f74933d864
Update sources 2022-12-01 13:52:49 +01:00
ab3190dcf1
Update sources
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-22 21:42:27 +01:00
30ae14dde1 Merge pull request 'Readme' (#15) from dancesWithCycles/handbuch-gen:readme into main
All checks were successful
continuous-integration/drone/push Build is passing
Reviewed-on: wtf-eg/handbuch-gen#15
2022-11-22 21:10:22 +01:00
b67f892ed5 #15 doc: add missing markdown
All checks were successful
continuous-integration/drone/pr Build is passing
2022-11-22 15:21:53 +01:00
f03e5d87eb #15 doc: summarized apt install 2022-11-22 15:20:28 +01:00
5334bf19bd
Update sources
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-22 14:35:30 +01:00
a65ea359d5 Merge pull request 'Automatically determine version' (#11) from auto-version into main
All checks were successful
continuous-integration/drone/push Build is passing
Reviewed-on: wtf-eg/handbuch-gen#11
2022-11-22 14:31:14 +01:00
27ec529d4a Merge pull request 'Einkaufskarten hinzugefügt' (#18) from einkaufskarten into main
All checks were successful
continuous-integration/drone/push Build is passing
Reviewed-on: wtf-eg/handbuch-gen#18
2022-11-15 21:47:27 +01:00
7d190dd4ad
Update sources
All checks were successful
continuous-integration/drone/pr Build is passing
2022-11-15 21:44:36 +01:00
Frank Lanitz
c49ddb0749 Einkaufskarten hinzugefügt
All checks were successful
continuous-integration/drone/pr Build is passing
2022-11-06 17:47:28 +01:00
b8b9be9891 #15 doc: add section: clean up
All checks were successful
continuous-integration/drone/pr Build is passing
2022-10-14 10:11:33 +02:00
2265935bd6 #15 doc: adjust section: other dependencies
All checks were successful
continuous-integration/drone/pr Build is passing
2022-10-14 09:55:46 +02:00
3414b67e58 #15 doc: adjust section: other dependencies
All checks were successful
continuous-integration/drone/pr Build is passing
2022-10-14 09:22:23 +02:00
8d6ee6f776 #15 doc: adjust section: checkout with submodules
All checks were successful
continuous-integration/drone/pr Build is passing
2022-10-14 08:28:08 +02:00
0474d264b5 Merge pull request 'Add business chapter' (#14) from add-business into main
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
Reviewed-on: wtf-eg/handbuch-gen#14
2022-09-17 10:56:13 +02:00
3b6161d64a
Add business chapter
All checks were successful
continuous-integration/drone/pr Build is passing
2022-09-17 10:53:25 +02:00
4688bc13ae Merge pull request 'Include mumble schema for external links' (#13) from fix-mumble-links into main
All checks were successful
continuous-integration/drone/push Build is passing
Reviewed-on: wtf-eg/handbuch-gen#13
2022-09-17 10:50:01 +02:00
fcc741b909
Include mumble schema for external links
All checks were successful
continuous-integration/drone/pr Build is passing
Fixes #2
2022-09-17 10:23:14 +02:00
4 changed files with 28 additions and 8 deletions

View File

@ -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```

View File

@ -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

View File

@ -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
==================