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 +14 -15
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 8be828dbe4 - Show all commits

29
README.md
View File

@ -1,18 +1,16 @@
# About # 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 the WTF handbook in various output formats (HTML, epub and pdf) from the [https://git.wtf-eg.de/wtf-eg/handbuch-gen](git repository for the WTF handbook). The handbuch sources are included as git submodule.
this project is an experiment of how to generate html, epub and pdf This repository contains the [https://www.sphinx-doc.org/](Sphinx) configuration and the WTF theme for Sphinx for the generation of 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 # 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 ## 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: This repository accesses the required WTF handbook's content as a git submodule. Therefore, make sure to check out this repository including its submodule:
@ -20,24 +18,25 @@ This repository accesses the required WTF handbook's content as a git submodule.
git clone --recurse-submodules https://git.wtf-eg.de/wtf-eg/handbuch-gen.git git clone --recurse-submodules https://git.wtf-eg.de/wtf-eg/handbuch-gen.git
``` ```
### Python based dependencies ## Python based dependencies
First create a Python 3 virtual environment using the venv module included with Python 3. In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
1. Create a virtual Python environment in the directory `venv` using the Python module `venv`: ```python3 -m venv venv``` 1. Create a virtual Python environment in the directory `venv`: ```python3 -m venv venv```
2. Activate the virtual Python environment: ```source venv/bin/activate``` 1. Activate the virtual Python environment: ```source venv/bin/activate```
3. Install the packages listed in [./requirements.txt](requirements.txt) using `pip`: ```pip install -r requirements.txt``` 1. Install the packages listed in [./requirements.txt](requirements.txt) using `pip`: ```pip install -r requirements.txt```
### Other dependencies ## Other dependencies
For generating the images from PlantUML sources (`*.plantuml`), [Plantuml](https://plantuml.com/) is required. For generating the images from PlantUML sources (`*.plantuml`), [Plantuml](https://plantuml.com/) is required.
For pdf output the latex builder is used, so latex and pdflatex need to be installed. For pdf output the latex builder is used, so latex and pdflatex need to be installed.
### Running the document generation via make ## Running the document generation via make
The top level directory contains a Makefile, The top level directory contains a Makefile, for generation with all output formats use
for generation with all output formats use
````` `````
make bundle make bundle
````` `````
The output files can then be found