From a9aacd4d48c3a5887267366c2ef643e953975792 Mon Sep 17 00:00:00 2001
From: Michal Cmarada <mcmarada@cisco.com>
Date: Mon, 11 Mar 2019 13:29:57 +0100
Subject: add documentation generator

Enables generating of HTML documentation. It depends on sphinx generator.
During configuration if sphinx is detected it will generate "docs" target
for make. To build the documentation use "make docs", which will build
the HTML documentation in build-root/html.

Change-Id: Ia627f7d26c954a2341e13a54006955d21d162802
Signed-off-by: Michal Cmarada <mcmarada@cisco.com>
---
 docs/docs.rst | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 docs/docs.rst

(limited to 'docs/docs.rst')

diff --git a/docs/docs.rst b/docs/docs.rst
new file mode 100644
index 0000000..ea44343
--- /dev/null
+++ b/docs/docs.rst
@@ -0,0 +1,42 @@
+.. _JVPP DOCUMENTATION:
+
+.. toctree::
+
+Building JVPP documentation
+===========================
+
+JVPP documentation uses restructured text format as source for generating documentation using sphinx generator.
+
+Dependencies
+------------
+
+You need to have sphinx installed in order to build the documentation for JVPP. To do so you can use pip to install it.
+
+.. code-block:: console
+
+  pip install sphinx
+
+You can use virtual environment for python or you can install it directly to the system.
+
+
+Building the documentation
+--------------------------
+
+In order to build the documentation you can use "docs" target which is automatically generated for make if sphinx
+generator is available.
+
+.. code-block:: console
+
+  make docs
+
+After successful build the generated documentation is available in build-root/html directory.
+
+Cleanup (Optional)
+------------------
+
+If you need to clean the build and remove all data that was generated during build (including documentation) you can
+use the clean.sh script.
+
+.. code-block:: console
+
+  ./clean.sh
-- 
cgit 1.2.3-korg