forked from gulliver/rtfm
Compare commits
No commits in common. "30ae14dde1025f4882386c86fdcc95881b2a25c7" and "5334bf19bd58bba309139acccc099e3853d1b9ad" have entirely different histories.
30ae14dde1
...
5334bf19bd
21
README.md
21
README.md
@ -17,14 +17,6 @@ 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
|
git clone --recurse-submodules https://git.wtf-eg.de/wtf-eg/handbuch-gen.git
|
||||||
```
|
```
|
||||||
|
|
||||||
If you cloned this repository initially without submobules, you can always update the content of submodule directories with the git submodule update command. Execute the command from the main project directory:
|
|
||||||
|
|
||||||
```
|
|
||||||
git submodule update --init --recursive
|
|
||||||
```
|
|
||||||
|
|
||||||
The --init flag initializes the submodules before the update. The --recursive option searches for nested submodules and ensures they are updated too.
|
|
||||||
|
|
||||||
### 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:
|
In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
|
||||||
@ -37,13 +29,7 @@ In order to generate the documentation, first create a Python 3 virtual environm
|
|||||||
|
|
||||||
For generating the images from PlantUML sources (`*.plantuml`), [PlantUML](https://plantuml.com/) is required.
|
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. On a clean (no Latex compilation yet) operating system like GNU/Debian, the following dependencies are required to make Latex compile the sources.
|
For pdf output the LaTeX builder is used, so `latex` and `pdflatex` need to be installed.
|
||||||
|
|
||||||
```
|
|
||||||
sudo apt install texlive-base texlive-latex-base texlive-latex-extra texlive-lang-german texlive-fonts-extra --no-install-recommends
|
|
||||||
```
|
|
||||||
|
|
||||||
For document generation `make` and `latexmk` is required.
|
|
||||||
|
|
||||||
### Running the document generation via make
|
### Running the document generation via make
|
||||||
|
|
||||||
@ -62,8 +48,3 @@ export SPHINXOPTS="-D version=$(git -C source/handbuch describe --tags --abbrev=
|
|||||||
The output files of the final handbook can be found in the subfolder `./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.
|
All generated intermediate artifacts and the final output files can be found in the `./build` subfolder.
|
||||||
|
|
||||||
### Clean up
|
|
||||||
|
|
||||||
1. Deactivate the virtual Python environment: ```deactivate```
|
|
||||||
2. Clean up the build sources: ```make clean``` and ```rm -r build bundle```
|
|
||||||
|
Reference in New Issue
Block a user