mirror of
https://github.com/vyos/vyos-documentation.git
synced 2025-10-26 08:41:46 +01:00
Update README.md with Docker build instructions
This commit is contained in:
parent
008377c0ec
commit
10deb82cbf
28
README.md
28
README.md
@ -1,7 +1,35 @@
|
|||||||
This is a playground for a new VyOS documentation starting for VyOS 1.2 (Crux)
|
This is a playground for a new VyOS documentation starting for VyOS 1.2 (Crux)
|
||||||
release.
|
release.
|
||||||
|
|
||||||
|
# Build
|
||||||
|
|
||||||
|
## Native
|
||||||
|
|
||||||
To build the manual run the following commands inside the `docs` folder:
|
To build the manual run the following commands inside the `docs` folder:
|
||||||
|
|
||||||
* `make html` for a HTML manual
|
* `make html` for a HTML manual
|
||||||
* `make latexpdf` for a LaTeX rendered PDF
|
* `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
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker run -v `pwd`:`pwd` -w `pwd`/docs -i -t --rm vyos-docu bash
|
||||||
|
```
|
||||||
|
|
||||||
|
Inside the container you can the build the documentation as stated above
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user