fib: use 32 bits per-source reference counter

[vpp.git] / docs / gettingstarted / writingdocs / buildingrst.rst

diff --git a/docs/gettingstarted/writingdocs/buildingrst.rst b/docs/gettingstarted/writingdocs/buildingrst.rst
index 5134bb3..474257d 100644 (file)
--- a/docs/gettingstarted/writingdocs/buildingrst.rst
+++ b/docs/gettingstarted/writingdocs/buildingrst.rst
@@ -20,6 +20,17 @@ Start with a clone of the vpp repository.
    $ cd vpp
 
 
+Install the Necessary Packages
+===============================
+
+Before building the docs there are some packages that are needed. To install
+these packages on ubuntu execute the following.
+
+.. code-block:: console
+
+   $ sudo apt-get install python3-all python3-setuptools python3-pip
+
+ 
 Create a Virtual Environment using virtualenv
 ===============================================
  
@@ -32,11 +43,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 +51,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 docs
+
+Clean the environment
+======================
+
+Delete all the generated files with the following:
 
 .. code-block:: console
 
-   $ make html
+   $ make docs-clean
 
 View the results
 =================