4 These instructions show how the VPP documentation sources are built.
6 To build your files, you can either Create a Virtual Environment using
7 virtualenv, which installs all the required applications for you.
9 Create a Virtual Environment using virtualenv
10 ============================
12 For more information on how to use the Python virtual environment check
13 out https://packaging.python.org/guides/installing-using-pip-and-virtualenv
16 ------------------------------
18 For example start with a clone of the vpp.
20 $ git clone https://gerrit.fd.io/r/vpp
23 Install the virtual environment
24 ----------------------------------------------
26 $ python -m pip install --user virtualenv
27 $ python -m virtualenv env
28 $ source env/bin/activate
29 $ pip install -r docs/etc/requirements.txt
32 Which installs all the required applications into it's own, isolated,
33 virtual environment, so as to not interfere with other builds that may
34 use different versions of software.
37 ----------------------------
39 Be sure you are in your vpp/docs directory, since that is where Sphinx will
40 look for your conf.py file, and build the documents into an index.html file
45 ------------------------
47 If there are no errors during the build process, you should now have an
48 index.html file in your vpp/docs/_build/html directory, which you can
49 then view in your browser.