blob: 87484405b30a1cf0b415e5ed46c6ebb615f862d2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
This is a playground for a new VyOS documentation starting for VyOS 1.2 (Crux)
release.
# Build
## Native
To build the manual run the following commands inside the `docs` folder:
* `make html` for a HTML manual
* `make latexpdf` for a LaTeX rendered PDF
Required Debian Packages:
* `python-sphinx`
* `python-sphinx-rtd-theme`
* `latexmk`
* `texlive-latex-recommended`
* `texlive-fonts-recommended`
* `texlive-latex-extra`
## Docker
Using our [Dockerfile](docker/Dockerfile) you create your own Docker container
that is used to build a VyOS documentation.
## Setup
```bash
$ docker build -t vyos-docu docker
```
### Build
Linux
```bash
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos-docu make html
```
|
