rtfm/README.md

97 lines
2.2 KiB
Markdown
Raw Normal View History

2021-07-12 10:07:43 +02:00
# rtfm
2021-07-29 09:50:25 +02:00
this projects is an experiment of how to generate html, epub and pdf
from the git repository for the WTF Handbook.
2021-08-05 22:15:18 +02:00
The handbuch sources are included as git submodule.
2021-07-29 09:50:25 +02:00
It contains a configuration for three different generators:
## mdbook and mdbook-epub
2021-08-05 22:27:25 +02:00
tbd
2021-07-29 09:50:25 +02:00
## crowbook
2021-08-05 22:27:25 +02:00
tbd
2021-07-29 09:50:25 +02:00
## sphinx
2021-08-05 22:27:25 +02:00
tbd
### sphinx html theme for wtf coop
the sphinx build uses an adapted sphinx theme for the wtf cooperatives CI.
2021-07-29 09:50:25 +02:00
## How to build
2021-08-05 22:15:18 +02:00
### rust based tools mdbook and crowbook
2021-08-01 18:15:18 +02:00
2021-08-05 22:15:18 +02:00
For building you need a rust installation.
This can be achieved by using the installer from https://rustup.rs
After installing the rust toolchain for your platform you have to install the needed tools:
````
cargo install mdbook
cargo install mdbook-epub
cargo install crowbook
````
Crowbook needs xelatex for building the pdf outputs.
### python based - sphinx
First create a Python 3 virtual environment using the venv module included with Python 3.
````
python -m venv py3-sphinx
`````
Now “activate” the environment. Look for the name of the virtual environment enclosed in parenthesis after activation.
`````
source py3-sphinx/bin/activate
``````
Expected Output
`````
(py3-sphinx) $
``````
In the virtual environment install the following modules with pip:
`````
2021-08-05 22:27:25 +02:00
(py3-sphinx) $ pip install sphinx3 sphinxcontrib-plantuml myst-parser
2021-08-05 22:15:18 +02:00
``````
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.
2021-08-05 22:27:25 +02:00
### Running the document generation via make
The top level directory contains a Makefile
For generation with all tools use
`````
make all
`````
For generation with single tool use:
`````
make mdbook [crowbook sphinx]
`````
2021-08-01 18:15:18 +02:00
## Issues
### mdbook - rendering problem with current inputs
### sphinx - Problems rendering latex with .svg image(organigramm.svg)
### problems rendering links not starting with http(s)
mumble and mailto links are not rendered correctly
tbd have an eye on all outputs
## TODO
2021-08-05 22:27:25 +02:00
- [ ] complete wtf coop HTML theme
- [ ] add frontpage with wtf coop CI
- [ ] adapt generated pdf to WTF design
- [ ] unify Title and authors in the configurations