3 **************************
5 **************************
7 These instructions show how the VPP documentation sources are built.
9 The VPP Documents are written using `reStructuredText <http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_ (rst),
10 or markdown (md). These files are then built using the Sphinx build system `Sphinx <http://www.sphinx-doc.org/en/master/>`_.
15 Start with a clone of the vpp repository.
17 .. code-block:: console
19 $ git clone https://gerrit.fd.io/r/vpp
23 Create a Virtual Environment using virtualenv
24 ===============================================
26 For more information on how to use the Python virtual environment check out
27 `Installing packages using pip and virtualenv`_.
29 .. _`Installing packages using pip and virtualenv`: https://packaging.python.org/guides/installing-using-pip-and-virtualenv/
31 In the vpp root directory on your system, run:
33 .. code-block:: console
37 Which installs all the required applications into it's own, isolated, virtual environment, so as to not
38 interfere with other builds that may use different versions of software.
41 ======================
43 Build the html **index.html** file:
45 .. code-block:: console
50 ======================
52 Delete all the generated files with the following:
54 .. code-block:: console
61 | If there are no errors during the build process, you should now have an **index.html** file in your
62 | **vpp/docs/_build/html** directory, which you can then view in your browser.
64 .. figure:: /_images/htmlBuild.png
65 :alt: Figure: My directory containing the index.html file
69 Whenever you make changes to your **.rst** files that you want to see, repeat this build process.
73 To exit from the virtual environment execute:
75 .. code-block:: console
79 Getting your documents reviewed and merged
80 ==========================================
82 VPP documents are reviewed and merged like and other source code. Refer to :ref:`gitreview`
83 to get your changes reviewed and merged.