forked from wtf-eg/handbuch-gen
45 lines
1.8 KiB
Markdown
45 lines
1.8 KiB
Markdown
[](https://drone.wtf-eg.de/wtf-eg/handbuch-gen)
|
|
|
|
# About
|
|
|
|
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.
|
|
|
|
This repository contains the [https://www.sphinx-doc.org/](Sphinx) configuration and the WTF theme for Sphinx for the generation of the WTF handbook.
|
|
|
|
# Sphinx HTML theme for wtf coop
|
|
|
|
the sphinx build uses an adapted sphinx theme for the WTF cooperatives CI.
|
|
|
|
# How to build
|
|
|
|
## 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
|
|
```
|
|
|
|
## Python based dependencies
|
|
|
|
In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
|
|
|
|
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```
|
|
|
|
## Other dependencies
|
|
|
|
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.
|
|
|
|
## Running the document generation via make
|
|
|
|
The top level directory contains a Makefile, for generation with all output formats use
|
|
|
|
`````
|
|
make bundle
|
|
`````
|
|
|
|
The output files can then be found
|