maehw
/
handbuch-gen
forked from wtf-eg/handbuch-gen
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add info how to checkout this repo properly

This commit is contained in:
maehw 2021-10-23 18:12:26 +02:00
parent 037235b0f5
commit dde5d5a732
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -3,15 +3,23 @@
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.
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.
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.