wtf-eg/handbuch-gen
Archived
1
0
Fork 2
forked from gulliver/rtfm
Code Issues Pull Requests Projects Releases Wiki Activity
rendering of wtf handbook with sphinx
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.
65 Commits 1 Branch 2 Tags 19 MiB
CSS 81.3%
HTML 15.2%
Python 2.7%
Makefile 0.8%
47eea37c63
Go to file
Stephan 47eea37c63 fix: removed anything but woff and woff2 from fontawesome
2021-10-03 16:16:15 +02:00
source fix: removed dependency on wtf_coop theme 2021-10-03 16:16:15 +02:00
theme fix: removed anything but woff and woff2 from fontawesome 2021-10-03 16:16:15 +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 fix: copied sphinx_rtd_theme to further shrink filesize 2021-10-03 16:16:15 +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.

  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