forked from gulliver/rtfm
Merge README Korrekturen von Maehw #6
@ -2,9 +2,9 @@
|
|||||||
|
|
||||||
# About
|
# About
|
||||||
|
|
||||||
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 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-gen). The handbuch sources are included as git submodule.
|
||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
|
|
||||||
# How to build
|
# How to build
|
||||||
@ -23,7 +23,7 @@ In order to generate the documentation, first create a Python 3 virtual environm
|
|||||||
|
|
||||||
1. Create a virtual Python environment in the directory `venv`: ```python3 -m venv venv```
|
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. 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```
|
1. Install the packages listed in [requirements.txt](./requirements.txt) using `pip`: ```pip install -r requirements.txt```
|
||||||
|
|
||||||
### Other dependencies
|
### Other dependencies
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user