docs/README

   1
   2 Building VPP Documents
   3
   4 These instructions show how the VPP documentation sources are built.
   5
   6 To build your files, you can either Create a Virtual Environment using
   7 virtualenv, which installs all the required applications for you.
   8
   9 Create a Virtual Environment using virtualenv
  10 ============================
  11
  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
  14
  15 Get the Documents
  16 ------------------------------
  17
  18 For example start with a clone of the vpp.
  19
  20 $ git clone https://gerrit.fd.io/r/vpp
  21 $ cd vpp
  22
  23 Install 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
  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.
  35
  36 Build the html files
  37 ----------------------------
  38
  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
  41
  42 $ make html
  43
  44 View the results
  45 ------------------------
  46
  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.