wtf-eg/handbuch-gen
Archived
1
0
Fork 2
forked from gulliver/rtfm
Code Issues Pull Requests Projects Releases Wiki Activity

Anpassungen an README.md #5

Closed
maehw wants to merge 8 commits from maehw:maehw-review into main
pull from: maehw:maehw-review
merge into: wtf-eg:main
Conversation 2 Commits 8 Files Changed 1 +10 -2
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit dde5d5a732 - Show all commits

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 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 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. The handbuch sources are included as git submodule.
# sphinx html theme for wtf coop # 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 # 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 ### python based - sphinx
First create a Python 3 virtual environment using the venv module included with Python 3. First create a Python 3 virtual environment using the venv module included with Python 3.