maehw/handbuch-gen
0
0
Fork 0
forked from wtf-eg/handbuch-gen
Code Issues Pull Requests Projects Releases Wiki Activity
rendering of wtf handbook with sphinx
73 Commits 3 Branches 0 Tags 18 MiB
CSS 81.4%
HTML 15.2%
Python 2.7%
Makefile 0.7%
26cb5fded4
Go to file
maehw 26cb5fded4 Changed heading levels back to original, added some more info and cross references
2021-10-23 22:33:59 +02:00
source fix: removed dependency on wtf_coop theme 2021-10-13 08:47:40 +02:00
theme fix: got rid of woff fonts to create minmal size build 2021-10-13 08:48:05 +02:00
.gitignore removed crowbook and mdbook configand moved sphinx dirs one level up 2021-09-08 16:34:25 +02:00
.gitmodules submodule url adapted to changed organisation for submodule handbuch 2021-09-23 21:52:06 +02:00
LICENSE Initial commit 2021-07-12 10:07:43 +02:00
Makefile fix: cleanup html build 2021-10-13 08:47:41 +02:00
README.md Changed heading levels back to original, added some more info and cross references 2021-10-23 22:33:59 +02:00
requirements.txt fix: copied sphinx_rtd_theme to further shrink filesize 2021-10-13 08:47:40 +02:00

README.md

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/ configuration and a Sphinx theme adapted for the [https://git.wtf-eg.de/ag_kommunikation/wtf_propaganda](corporate identity of WTF cooperation).

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
  2. Activate the virtual Python environment: source venv/bin/activate
  3. Install the packages listed in ./requirements.txt using pip: pip install -r requirements.txt

Other dependencies

For generating the images from PlantUML sources (*.plantuml), Plantuml 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 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.