handbuch-gen/README.md

68 lines
2.9 KiB
Markdown
Raw Normal View History

2021-11-08 15:03:00 +01:00
[![Build Status](https://drone.wtf-eg.de/api/badges/wtf-eg/handbuch-gen/status.svg)](https://drone.wtf-eg.de/wtf-eg/handbuch-gen)
# About
2021-10-23 22:36:31 +02:00
This project is an experiment of how to generate the WTF handbook in various output formats (HTML, epub and pdf) from the [git repository for the WTF handbook](https://git.wtf-eg.de/wtf-eg/handbuch). The handbuch sources are included as git submodule.
2021-07-12 10:07:43 +02:00
2021-10-23 22:36:06 +02:00
This repository contains the [Sphinx](https://www.sphinx-doc.org/) configuration and a Sphinx theme adapted for the [corporate identity of WTF cooperation](https://git.wtf-eg.de/ag_kommunikation/wtf_propaganda).
2021-07-29 09:50:25 +02:00
# How to build
2021-08-05 22:15:18 +02:00
### Checkout with submodules
This repository accesses the required WTF handbook's content as a git submodule. Therefore, make sure to check out this repository including its 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
2021-08-05 22:15:18 +02:00
2021-10-23 22:28:10 +02:00
In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
2021-08-05 22:15:18 +02:00
2021-10-23 22:28:10 +02:00
1. Create a virtual Python environment in the directory `venv`: ```python3 -m venv venv```
1. Activate the virtual Python environment: ```source venv/bin/activate```
2021-10-23 22:36:06 +02:00
1. Install the packages listed in [requirements.txt](./requirements.txt) using `pip`: ```pip install -r requirements.txt```
### Other dependencies
2021-08-05 22:15:18 +02:00
2021-10-23 22:39:29 +02:00
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 --no-install-recommends
sudo apt-get install texlive-latex-base --no-install-recommends
sudo apt-get install texlive-latex-extra --no-install-recommends
sudo apt-get install texlive-lang-german --no-install-recommends
sudo apt-get install texlive-fonts-extra --no-install-recommends
```
2021-08-05 22:15:18 +02:00
For document generation `make` and latexmk` is required.
### Running the document generation via make
2021-08-05 22:27:25 +02:00
2021-10-23 22:28:10 +02:00
The top level directory contains a Makefile, for generation with all output formats use
2021-08-05 22:27:25 +02:00
`````
make bundle
2021-08-05 22:27:25 +02:00
`````
2021-10-23 22:28:10 +02:00
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.
2022-10-14 10:11:33 +02:00
### Clean up
1. Deactivate the virtual Python environment: ```deactivate```
2. Clean up the build sources: ```make clean``` and ```rm -r build bundle```