summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorclient <client@postoffice.intern>2020-01-15 00:44:03 +0330
committerclient <client@postoffice.intern>2020-01-15 00:44:03 +0330
commita7cef06c95cbd5aed95107634b22df891507d7b0 (patch)
treeb88c9dfa35da6f2cd371fb4c3f4e9a6a291be14d /README.md
parentbea7c7318f0f7d2d6e11ee1d4db840fa7f88941a (diff)
downloadvyos-documentation-a7cef06c95cbd5aed95107634b22df891507d7b0.tar.gz
vyos-documentation-a7cef06c95cbd5aed95107634b22df891507d7b0.zip
Declare python3 requirements for native build, update relevant section
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 21 insertions, 6 deletions
diff --git a/README.md b/README.md
index 908d04d3..b9841171 100644
--- a/README.md
+++ b/README.md
@@ -16,22 +16,37 @@ 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` (See sphinx below)
-### sphinx-autobuild
-Required extra setup procedure on Debian:
+### sphinx
+Installing `sphinx`, `sphinx-autobuild` and `sphinx-rtd-theme` packages
+on Debian, requires some extra steps:
+First ensure that phython3 is the default one
```bash
+python --version
+```
+
+Alternatively, to make python3 the default fix the following line to
+point to relevant 3.x version of 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