rendering from markdown documents for handbook with different documentation generators to html, pub and pdf

Go to file

Stephan 2636a8b177 fix: syntax		2021-10-13 08:47:40 +02:00
source	handbuch module set to tag version 0.1.0, set version in conf.py	2021-10-13 08:46:56 +02:00
theme	fix: syntax	2021-10-13 08:47:40 +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	removed crowbook and mdbook configand moved sphinx dirs one level up	2021-09-08 16:34:25 +02:00
README.md	adapted README.md to changed content of package (only sphinx stays in the repo)	2021-09-16 09:21:56 +02:00
requirements.txt	docs: reduced install efforts with creation of requirements.txt	2021-08-28 16:48:06 +02:00

README.md

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

python based - sphinx

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

Create a virtual Python environment: python3 -m venv venv
Activate virtual Python environment: source venv/bin/activate
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