wtf-eg/handbuch-gen
Archived
1
0
Fork 2
forked from gulliver/rtfm
Code Issues Pull Requests Projects Releases Wiki Activity
This repository has been archived on 2023-04-12. You can view files and clone it, but cannot push or open issues or pull requests.
dde5d5a732
handbuch-gen/README.md

1.4 KiB
Raw Blame History

About

This repo contains the sphinx configuration and the wtf theme for sphinx for the generation of the WTF handbook.

this project is an experiment of how to generate html, epub and pdf from the git repository for the WTF handbook. The handbuch sources are included as git submodule.

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

First create a Python 3 virtual environment using the venv module included with Python 3.

  1. Create a virtual Python environment: python3 -m venv venv
  2. Activate virtual Python environment: source venv/bin/activate
  3. install needed packages from requirements.txt: pip install -r requirements.txt

For generating the images from plantuml-sources it needs also Plantuml. For pdf output the latex builder is used, so it needs also an installed latex and pdflatex.

Running the document generation via make

The top level directory contains a Makefile, for generation with all output formats use

make bundle