aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/gettingstarted/writingdocs/buildingrst.rst20
-rwxr-xr-xdocs/scripts/sphinx-make.sh14
2 files changed, 26 insertions, 8 deletions
diff --git a/docs/gettingstarted/writingdocs/buildingrst.rst b/docs/gettingstarted/writingdocs/buildingrst.rst
index 5134bb395ee..46830ca2580 100644
--- a/docs/gettingstarted/writingdocs/buildingrst.rst
+++ b/docs/gettingstarted/writingdocs/buildingrst.rst
@@ -32,11 +32,7 @@ In the vpp root directory on your system, run:
.. code-block:: console
- $ python -m pip install --user virtualenv
- $ python -m virtualenv env
- $ source env/bin/activate
- $ pip install -r docs/etc/requirements.txt
- $ cd docs
+ $ make docs-venv
Which installs all the required applications into it's own, isolated, virtual environment, so as to not
interfere with other builds that may use different versions of software.
@@ -44,12 +40,20 @@ interfere with other builds that may use different versions of software.
Build the html files
======================
-Be sure you are in your vpp-docs/docs directory, since that is where Sphinx will look for your **conf.py**
-file, and build the **.rst** files into an **index.html** file:
+Build the html **index.html** file:
.. code-block:: console
- $ make html
+ $ make docs
+
+Clean the environment
+======================
+
+Delete all the generated files with the following:
+
+.. code-block:: console
+
+ $ make docs-clean
View the results
=================
diff --git a/docs/scripts/sphinx-make.sh b/docs/scripts/sphinx-make.sh
new file mode 100755
index 00000000000..e95b3eba066
--- /dev/null
+++ b/docs/scripts/sphinx-make.sh
@@ -0,0 +1,14 @@
+#!/bin/bash
+
+if [ "$1" == "venv" ]
+then
+ python -m pip install --user virtualenv
+ python -m virtualenv $VENV_DIR
+ source $VENV_DIR/bin/activate;
+ pip install -r $DOCS_DIR/etc/requirements.txt
+else
+ source $VENV_DIR/bin/activate;
+ make -C $DOCS_DIR $1
+fi
+
+deactivate