aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/writingdocs
diff options
context:
space:
mode:
authorjdenisco <jdenisco@cisco.com>2018-09-24 14:59:33 -0400
committerDamjan Marion <dmarion@me.com>2018-09-24 21:37:00 +0000
commit3138d723091234a3534baa8b1bbaad31df6fb8d6 (patch)
tree6d739fda1349dd98cdb6d0ef54743015b97c3fd0 /docs/gettingstarted/writingdocs
parentedb3a9bca826ddaaf5f3c7ee83f9e474bd2a2e11 (diff)
Add the sphinx docs build options
Change-Id: If7ac5b41ca4ac602a100b616b37d07f658fd6a90 Signed-off-by: jdenisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/gettingstarted/writingdocs')
-rw-r--r--docs/gettingstarted/writingdocs/buildingrst.rst20
1 files changed, 12 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
=================