vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Remove obsolete information about native documentation generation

Browse Source
This commit is contained in:
erkin 2022-02-12 11:30:14 +03:00
parent 6b1fccde27
commit 174b3fe9bb
2 changed files with 1 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -28,20 +28,6 @@ largest. There are 88 of them, here's the
* 1.4.x: `sagitta` (Arrow) * 1.4.x: `sagitta` (Arrow)
* ... * ...
## Native
To build the manual, run the following commands inside the `docs` folder:
* `make html` for an HTML manual
* `make latexpdf` for a LaTeX rendered PDF
Required Debian Packages:
* `latexmk`
* `texlive-latex-recommended`
* `texlive-fonts-recommended`
* `texlive-latex-extra`
* `sphinx`
### sphinx ### sphinx
Debian requires some extra steps for Debian requires some extra steps for
installing `sphinx`, `sphinx-autobuild` and `sphinx-rtd-theme` packages: installing `sphinx`, `sphinx-autobuild` and `sphinx-rtd-theme` packages:
@ -76,7 +62,6 @@ Then run:
sudo pip install sphinx-rtd-theme sudo pip install sphinx-rtd-theme
``` ```
Do the following to build the HTML and start a webserver: Do the following to build the HTML and start a webserver:
* Run `make livehtml` inside the `docs` folder * Run `make livehtml` inside the `docs` folder

2
docs/documentation.rst
View File

@ -91,7 +91,7 @@ access to the official codebase.
for writing our docs. Additional directives how to write in RST can be for writing our docs. Additional directives how to write in RST can be
obtained from reStructuredTextDirectives_. obtained from reStructuredTextDirectives_.
* Check your changes by locally building the documentation ``$ make html``. * Check your changes by locally building the documentation ``$ make livehtml``.
Sphinx will build the html files in the ``docs/_build`` folder. We provide Sphinx will build the html files in the ``docs/_build`` folder. We provide
you with a Docker container for an easy-to-use user experience. Check the you with a Docker container for an easy-to-use user experience. Check the
README.md_ file of this repository. README.md_ file of this repository.