diff options
author | John DeNisco <jdenisco@cisco.com> | 2018-07-26 16:21:31 -0400 |
---|---|---|
committer | Dave Barach <openvpp@barachs.net> | 2018-07-27 00:13:36 +0000 |
commit | 2d1a04371a8e61f9d5ba8b028f41fcbcec017b9c (patch) | |
tree | b2d23b0b9619c0fe75b190e505af66c4e21e07b7 /docs/README | |
parent | 9bae0ca53ba0497867881977c0386eb627ab59f3 (diff) |
Fix .gitignore so docs/Makefile is not ignored. Add README and Makefile. Fis gitreview.
Change-Id: I3d664d9c881ce127a09b9d68c1181a7098a39074
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/README')
-rw-r--r-- | docs/README | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/README b/docs/README new file mode 100644 index 00000000000..d9a70912edb --- /dev/null +++ b/docs/README @@ -0,0 +1,49 @@ + +Building VPP Documents + +These instructions show how the VPP documentation sources are built. + +To build your files, you can either Create a Virtual Environment using +virtualenv, which installs all the required applications for you. + +Create a Virtual Environment using virtualenv +============================ + +For more information on how to use the Python virtual environment check +out https://packaging.python.org/guides/installing-using-pip-and-virtualenv + +Get the Documents +------------------------------ + +For example start with a clone of the vpp. + +$ git clone https://gerrit.fd.io/r/vpp +$ cd vpp + +Install the virtual environment +---------------------------------------------- + +$ python -m pip install --user virtualenv +$ python -m virtualenv env +$ source env/bin/activate +$ pip install -r docs/etc/requirements.txt +$ cd docs + +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 +---------------------------- + +Be sure you are in your vpp/docs directory, since that is where Sphinx will +look for your conf.py file, and build the documents into an index.html file + +$ make html + +View the results +------------------------ + +If there are no errors during the build process, you should now have an +index.html file in your vpp/docs/_build/html directory, which you can +then view in your browser. |