handbuch-gen/README.md

45 lines
1.8 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:28:10 +02:00
This project is an experiment of how to generate the WTF handbook in various output formats (HTML, epub and pdf) from the [https://git.wtf-eg.de/wtf-eg/handbuch-gen](git repository for the WTF handbook). The handbuch sources are included as git submodule.
2021-07-12 10:07:43 +02:00
2021-10-23 22:28:10 +02:00
This repository contains the [https://www.sphinx-doc.org/](Sphinx) configuration and the WTF theme for Sphinx for the generation of the WTF handbook.
2021-07-29 09:50:25 +02:00
2021-10-23 22:28:10 +02:00
# Sphinx HTML theme for wtf coop
2021-08-05 22:27:25 +02:00
the sphinx build uses an adapted sphinx theme for the WTF cooperatives CI.
2021-07-29 09:50:25 +02:00
# How to build
2021-08-05 22:15:18 +02:00
2021-10-23 22:28:10 +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
```
2021-10-23 22:28:10 +02:00
## 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```
1. Install the packages listed in [./requirements.txt](requirements.txt) using `pip`: ```pip install -r requirements.txt```
2021-10-23 22:28:10 +02:00
## Other dependencies
2021-08-05 22:15:18 +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.
2021-08-05 22:15:18 +02:00
2021-10-23 22:28:10 +02:00
## 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 can then be found