gulliver/rtfm
1
0
Fork 2
Code Issues Pull Requests Projects Releases Activity

Changed heading levels back to original, added some more info and cross references

Browse Source
This commit is contained in:
maehw 2021-10-23 22:33:59 +02:00 committed by Gulliver
parent bef5199114
commit 204abce3b4
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -4,15 +4,12 @@
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 repository contains the [https://www.sphinx-doc.org/](Sphinx) configuration and the WTF theme for Sphinx for the generation of the WTF handbook.
This repository contains the [https://www.sphinx-doc.org/](Sphinx) configuration and a Sphinx theme adapted for the [https://git.wtf-eg.de/ag_kommunikation/wtf_propaganda](corporate identity of WTF cooperation).
# Sphinx HTML theme for wtf coop
the sphinx build uses an adapted sphinx theme for the WTF cooperatives CI.
# 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:
@ -20,7 +17,7 @@ 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
```
## Python based dependencies
### Python based dependencies
In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
@ -28,12 +25,12 @@ In order to generate the documentation, first create a Python 3 virtual environm
1. Activate the virtual Python environment: ```source venv/bin/activate```
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 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, for generation with all output formats use
@ -41,4 +38,6 @@ The top level directory contains a Makefile, for generation with all output form
make bundle
`````
The output files can then be found
The output files of the final handbook can be found in the subfolder `./bundle`.
All generated intermediate artifacts and the final output files can be found in the `./build` subfolder.