forked from wtf-eg/handbuch-gen
Compare commits
11 Commits
fix/reduce
...
maehw-revi
Author | SHA1 | Date | |
---|---|---|---|
d9ce62fbf9 | |||
9d888fa501 | |||
c47e3f4612 | |||
204abce3b4 | |||
bef5199114 | |||
fdd6b6adee | |||
3aec12d210 | |||
af1449c5f4 | |||
5b8a1feb73 | |||
24a7a58811 | |||
037235b0f5 |
42
README.md
42
README.md
@ -1,34 +1,44 @@
|
|||||||
|
[](https://drone.wtf-eg.de/wtf-eg/handbuch-gen)
|
||||||
|
|
||||||
# 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 [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
|
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).
|
||||||
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
|
||||||
|
|
||||||
### 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```
|
### Python based dependencies
|
||||||
2. Activate virtual Python environment: ```source venv/bin/activate```
|
|
||||||
3. install needed packages from ```requirements.txt```: ```pip install -r requirements.txt```
|
|
||||||
|
|
||||||
For generating the images from plantuml-sources it needs also [Plantuml](https://plantuml.com/).
|
In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
|
||||||
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,
|
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 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.
|
||||||
|
Submodule source/handbuch updated: 2bb2f9dcc1...c4ba3f2e8c
@ -4,16 +4,14 @@
|
|||||||
*/
|
*/
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: FontAwesome;
|
font-family: FontAwesome;
|
||||||
src: url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),
|
src: url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2");
|
||||||
url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff");
|
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
font-style: normal
|
font-style: normal
|
||||||
}
|
}
|
||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: Lato;
|
font-family: Lato;
|
||||||
src: url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),
|
src: url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2");
|
||||||
url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");
|
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
font-display: block
|
font-display: block
|
||||||
@ -21,8 +19,7 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: Lato;
|
font-family: Lato;
|
||||||
src: url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),
|
src: url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2");
|
||||||
url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");
|
|
||||||
font-weight: 700;
|
font-weight: 700;
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
font-display: block
|
font-display: block
|
||||||
@ -30,8 +27,7 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: Lato;
|
font-family: Lato;
|
||||||
src: url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),
|
src: url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2");
|
||||||
url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");
|
|
||||||
font-weight: 700;
|
font-weight: 700;
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
font-display: block
|
font-display: block
|
||||||
@ -39,8 +35,7 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: Lato;
|
font-family: Lato;
|
||||||
src: url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),
|
src: url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2");
|
||||||
url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");
|
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
font-display: block
|
font-display: block
|
||||||
@ -49,8 +44,7 @@
|
|||||||
/* noto-serif-700 - latin */
|
/* noto-serif-700 - latin */
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Noto Serif Bold';
|
font-family: 'Noto Serif Bold';
|
||||||
src: url('fonts/noto-serif-v9-latin-700.woff2') format('woff2'), /* Super Modern Browsers */
|
src: url('fonts/noto-serif-v9-latin-700.woff2') format('woff2'); /* Modern Browsers */
|
||||||
url('fonts/noto-serif-v9-latin-700.woff') format('woff'); /* Modern Browsers */
|
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
font-weight: 700;
|
font-weight: 700;
|
||||||
}
|
}
|
||||||
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Reference in New Issue
Block a user