diff --git a/README.md b/README.md index 0c04a5d..93dc8de 100644 --- a/README.md +++ b/README.md @@ -2,35 +2,43 @@ # 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 [git repository for the WTF handbook](https://git.wtf-eg.de/wtf-eg/handbuch). The handbuch sources are included as git submodule. -this project is an experiment of how to generate html, epub and pdf -from the git repository for the WTF Handbook. -The handbuch sources are included as git submodule. +This repository contains the [Sphinx](https://www.sphinx-doc.org/) configuration and a Sphinx theme adapted for the [corporate identity of WTF cooperation](https://git.wtf-eg.de/ag_kommunikation/wtf_propaganda). -# sphinx html theme for wtf coop - -the sphinx build uses an adapted sphinx theme for the wtf cooperatives CI. # How to build -### python based - sphinx +### Checkout with submodules -First create a Python 3 virtual environment using the venv module included with Python 3. +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 +``` -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``` +### Python based dependencies -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. +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`: ```python3 -m venv venv``` +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 + +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 -The top level directory contains a Makefile, -for generation with all output formats use +The top level directory contains a Makefile, for generation with all output formats use ````` make bundle ````` + +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.