Creating VPP Documents¶
These instructions show how the VPP documentation sources are built.
Get the VPP sources¶
Start with a clone of the vpp repository.
$ git clone https://gerrit.fd.io/r/vpp $ 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.
$ sudo apt-get install python3-all python3-setuptools python3-pip
Create a Virtual Environment using virtualenv¶
For more information on how to use the Python virtual environment check out Installing packages using pip and virtualenv.
In the vpp root directory on your system, run:
$ 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.
Build the html files¶
Build the html index.html file:
$ make docs
Clean the environment¶
Delete all the generated files with the following:
$ make docs-clean
View the results¶
Whenever you make changes to your .rst files that you want to see, repeat this build process.
To exit from the virtual environment execute: