3 Writing VPP Documentation
4 =========================
6 These instructions show how the VPP documentation sources are built.
8 The VPP Documents are written using `reStructuredText <http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_ (rst),
9 or markdown (md). These files are then built using the Sphinx build system `Sphinx <http://www.sphinx-doc.org/en/master/>`_.
14 Start with a clone of the vpp repository.
16 .. code-block:: console
18 $ git clone https://gerrit.fd.io/r/vpp
21 Build the html **index.html** file:
23 .. code-block:: console
27 Delete all the generated files with the following:
29 .. code-block:: console
36 If there are no errors during the build process, you should now have an ``index.html`` file in your ``vpp/build-root/docs/html`` directory, which you can then view in your browser.
38 Whenever you make changes to your ``.rst`` files that you want to see, repeat this build process.
40 Writing Docs and merging
41 ------------------------
43 Documentation should be added as ``.rst`` file in the ``./src/`` tree next to the code it refers to. A symlink should be added at the relevant place in the ``./docs`` folder and a link in the appropriate place in the tree.
45 To ensure documentation is correctly inserted, you can run
47 .. code-block:: console
49 $ ./extras/scripts/check_documentation.sh
51 VPP documents are reviewed and merged like and other source code. Refer to :ref:`gitreview`
52 to get your changes reviewed and merged.