forked from gulliver/rtfm
Compare commits
8 Commits
212473fe0a
...
b580c8d439
Author | SHA1 | Date | |
---|---|---|---|
|
b580c8d439 | ||
|
54494acf28 | ||
|
9f75f3b21a | ||
|
030285b17e | ||
|
938eb4228a | ||
|
dfc88edfdd | ||
|
3dbca4d055 | ||
|
f7f8ca6dbb |
40
README.md
40
README.md
@ -2,43 +2,35 @@
|
|||||||
|
|
||||||
# About
|
# About
|
||||||
|
|
||||||
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 repo contains the sphinx configuration and the wtf theme for sphinx for the generation of the WTF handbook.
|
||||||
|
|
||||||
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).
|
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.
|
||||||
|
|
||||||
|
# sphinx html theme for wtf coop
|
||||||
|
|
||||||
|
the sphinx build uses an adapted sphinx theme for the wtf cooperatives CI.
|
||||||
|
|
||||||
# How to build
|
# How to build
|
||||||
|
|
||||||
### Checkout with submodules
|
### python based - sphinx
|
||||||
|
|
||||||
This repository accesses the required WTF handbook's content as a git submodule. Therefore, make sure to check out this repository including its submodule:
|
First create a Python 3 virtual environment using the venv module included with Python 3.
|
||||||
|
|
||||||
```
|
|
||||||
git clone --recurse-submodules https://git.wtf-eg.de/wtf-eg/handbuch-gen.git
|
|
||||||
```
|
|
||||||
|
|
||||||
### Python based dependencies
|
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```
|
||||||
|
|
||||||
In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
|
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.
|
||||||
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
|
### 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
|
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.
|
|
||||||
|
@ -24,7 +24,7 @@ copyright = '2021, diverse'
|
|||||||
author = 'Autorenkollektiv'
|
author = 'Autorenkollektiv'
|
||||||
|
|
||||||
# The full version, including alpha/beta/rc tags
|
# The full version, including alpha/beta/rc tags
|
||||||
release = '0.2.0'
|
release = '0.1.0'
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user