blob: 5b45873bcae009b0be776a410f7ba4143452e217 (
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
38
39
40
41
|
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
## Create Container
```bash
$ docker build -t vyos-docu - < Dockerfile
```
### Build Documentation
Linux
```bash
$ docker run -v `pwd`:`pwd` -w `pwd`/docs -i -t --rm vyos-docu bash
```
Windows PowerShell
```powershell
docker run -v "$($pwd.path):/vyos" -w "/vyos/docs" -i -t --rm vyos-docu bash
```
Inside the container you can the build the documentation as stated above
|
