rtfm/README.md

35 lines
1.1 KiB
Markdown
Raw Normal View History

# About
This repo contains the sphinx configuration and the wtf theme for sphinx for the generation of the WTF handbook.
2021-07-12 10:07:43 +02:00
2021-08-05 22:29:04 +02:00
this project is an experiment of how to generate html, epub and pdf
2021-07-29 09:50:25 +02:00
from the git repository for the WTF Handbook.
2021-08-05 22:15:18 +02:00
The handbuch sources are included as git submodule.
2021-07-29 09:50:25 +02:00
# sphinx html theme for wtf coop
2021-08-05 22:27:25 +02:00
the sphinx build uses an adapted sphinx theme for the wtf cooperatives CI.
2021-07-29 09:50:25 +02:00
# How to build
2021-08-05 22:15:18 +02:00
### 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```
2021-08-05 22:15:18 +02:00
For generating the images from plantuml-sources it needs also [Plantuml](https://plantuml.com/).
For pdf output the latex builder is used, so it needs also an installed latex and pdflatex.
2021-08-05 22:27:25 +02:00
### Running the document generation via make
The top level directory contains a Makefile,
for generation with all output formats use
2021-08-05 22:27:25 +02:00
`````
make bundle
2021-08-05 22:27:25 +02:00
`````