summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2020-01-15 15:58:00 +0100
committerGitHub <noreply@github.com>2020-01-15 15:58:00 +0100
commitdf79114b9b1bd7bcbf3a17836667d0f99c5effc9 (patch)
treea12e6c063761069f60657e5156e978ea2c9831c0
parentbea7c7318f0f7d2d6e11ee1d4db840fa7f88941a (diff)
parent7dea3052322ac8f39c966aeb8e52269ea4bd6486 (diff)
downloadvyos-documentation-df79114b9b1bd7bcbf3a17836667d0f99c5effc9.tar.gz
vyos-documentation-df79114b9b1bd7bcbf3a17836667d0f99c5effc9.zip
Merge pull request #184 from fakoor/revise-native-build
Revise native build
-rw-r--r--README.md29
1 files changed, 23 insertions, 6 deletions
diff --git a/README.md b/README.md
index 908d04d3..402dfbbc 100644
--- a/README.md
+++ b/README.md
@@ -16,22 +16,39 @@ To build the manual run the following commands inside the `docs` folder:
* `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`
+* `sphinx`
-### sphinx-autobuild
-Required extra setup procedure on Debian:
+### sphinx
+Debian, requires some extra steps for
+installing `sphinx`, `sphinx-autobuild` and `sphinx-rtd-theme` packages:
+
+First ensure that phython3 is the default:
+```bash
+python --version
+```
+
+Alternatively, to make python3 the default, revise the following line to
+point to the relevant 3.x version of the binary on your system:
+
+```bash
+sudo update-alternatives --install /usr/bin/python python /usr/bin/python3....
+```
+
+Then follow these steps to install sphinx group of packages:
```bash
+sudo apt-get install python3-sphinx
sudo apt-get install python-pip
+sudo pip install sphinx-rtd-theme
sudo pip install sphinx-autobuild
```
-To build and run a webeserver, inside the `docs` folder:
-* `make livehtml` and browse to http://localhost:8000
+To build the html, start a webeserver, and view the output:
+* Run `make livehtml` inside the `docs` folder
+* Browse to http://localhost:8000
## Docker