NameDateSize

..18-Feb-20204 KiB

_images/H08-Aug-20194 KiB

_static/H26-Jul-201865

about.rstH A D11-Dec-2019117

archive/H18-Sep-201823

conf.pyH A D24-Jan-20205.5 KiB

etc/H24-Jan-202030

events/H09-Aug-201889

featuresbyrelease/H06-Nov-2019277

gettingstarted/H17-Aug-2018113

index.rstH A D06-Nov-20191.6 KiB

links/H18-Sep-201823

MakefileH A D06-Nov-20191.5 KiB

READMEH A D27-Jul-20181.4 KiB

reference/H19-Feb-201994

relatedprojects/H18-Sep-201823

scripts/H24-Jan-202078

troubleshooting/H24-Jan-202087

usecases/H11-Feb-20204 KiB

whatisvpp/H06-Nov-2019201

README

1
2Building VPP Documents
3
4These instructions show how the VPP documentation sources are built.
5
6To build your files, you can either Create a Virtual Environment using
7virtualenv, which installs all the required applications for you.
8
9Create a Virtual Environment using virtualenv
10============================
11
12For more information on how to use the Python virtual environment check
13out https://packaging.python.org/guides/installing-using-pip-and-virtualenv
14
15Get the Documents
16------------------------------
17
18For example start with a clone of the vpp.
19
20$ git clone https://gerrit.fd.io/r/vpp
21$ cd vpp
22
23Install the virtual environment
24----------------------------------------------
25
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
30$ cd docs
31
32Which installs all the required applications into it's own, isolated,
33virtual environment, so as to not interfere with other builds that may
34use different versions of software.
35
36Build the html files
37----------------------------
38
39Be sure you are in your vpp/docs directory, since that is where Sphinx will
40look for your conf.py file, and build the documents into an index.html file
41
42$ make html
43
44View the results
45------------------------
46
47If there are no errors during the build process, you should now have an
48index.html file in your vpp/docs/_build/html directory, which you can
49then view in your browser.
50