diff options
| author | erkin <e.altunbas@vyos.io> | 2022-02-12 11:30:14 +0300 |
|---|---|---|
| committer | erkin <e.altunbas@vyos.io> | 2022-02-12 11:30:14 +0300 |
| commit | 174b3fe9bb73712485d99b2d0ce4a6866585b252 (patch) | |
| tree | 9799bb8c14eb5f8d5e4746fb679e0c5cb368938d | |
| parent | 6b1fccde2784a42b38936ceeea3477116aef40ad (diff) | |
| download | vyos-documentation-174b3fe9bb73712485d99b2d0ce4a6866585b252.tar.gz vyos-documentation-174b3fe9bb73712485d99b2d0ce4a6866585b252.zip | |
Remove obsolete information about native documentation generation
| -rw-r--r-- | README.md | 15 | ||||
| -rw-r--r-- | docs/documentation.rst | 2 |
2 files changed, 1 insertions, 16 deletions
@@ -28,20 +28,6 @@ largest. There are 88 of them, here's the * 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 Debian requires some extra steps for installing `sphinx`, `sphinx-autobuild` and `sphinx-rtd-theme` packages: @@ -76,7 +62,6 @@ Then run: sudo pip install sphinx-rtd-theme ``` - Do the following to build the HTML and start a webserver: * Run `make livehtml` inside the `docs` folder diff --git a/docs/documentation.rst b/docs/documentation.rst index 00db6e56..77cd5cc4 100644 --- a/docs/documentation.rst +++ b/docs/documentation.rst @@ -91,7 +91,7 @@ access to the official codebase. for writing our docs. Additional directives how to write in RST can be 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 you with a Docker container for an easy-to-use user experience. Check the README.md_ file of this repository. |