docs: better docs, mv doxygen to sphinx

This patch refactors the VPP sphinx docs
in order to make it easier to consume
for external readers as well as VPP developers.

It also makes sphinx the single source
of documentation, which simplifies maintenance
and operation.

Most important updates are:

- reformat the existing documentation as rst
- split RELEASE.md and move it into separate rst files
- remove section 'events'
- remove section 'archive'
- remove section 'related projects'
- remove section 'feature by release'
- remove section 'Various links'
- make (Configuration reference, CLI docs,
  developer docs) top level items in the list
- move 'Use Cases' as part of 'About VPP'
- move 'Troubleshooting' as part of 'Getting Started'
- move test framework docs into 'Developer Documentation'
- add a 'Contributing' section for gerrit,
  docs and other contributer related infos
- deprecate doxygen and test-docs targets
- redirect the "make doxygen" target to "make docs"

Type: refactor

Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>

1 files changed, 96 insertions, 9 deletions

diff --git a/docs/index.rst b/docs/index.rst
index 238931e8d3d..fcb63eea11a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -26,18 +26,105 @@ and multiple kinds of packet tracing. Development debug images
 include complete symbol tables, and extensive consistency checking.
 
 Some VPP Use-cases include vSwitches, vRouters, Gateways, Firewalls
-and Load Balancers, to name a few.
+and Load-Balancers, to name a few.
 
 For more details click on the links below or press next.
 
 .. toctree::
+   :caption: About VPP
+   :maxdepth: 1
+
+   aboutvpp/scalar-vs-vector-packet-processing
+   aboutvpp/extensible
+   aboutvpp/networkstack
+   aboutvpp/hoststack
+   aboutvpp/developer
+   aboutvpp/supported
+   aboutvpp/performance
+   aboutvpp/releasenotes/index
+   aboutvpp/featurelist
+
+.. toctree::
+   :caption: Use Cases
+   :maxdepth: 1
+
+   usecases/containers/index
+   usecases/simpleperf/index
+   usecases/vppcloud/index
+   usecases/vhost/index
+   usecases/vmxnet3
+   usecases/home_gateway
+   usecases/acls
+   usecases/networksim
+   usecases/webapp
+   usecases/container_test
+   usecases/trafficgen
+   usecases/ikev2/index
+   usecases/contiv/index
+
+
+.. toctree::
+   :caption: Getting started
    :maxdepth: 2
 
-   whatisvpp/index.rst
-   gettingstarted/index
-   links/index
-   usecases/index
-   troubleshooting/index
-   reference/index
-   relatedprojects/index
-   about.rst
+   gettingstarted/installing/index
+   gettingstarted/running/index
+   gettingstarted/progressivevpp/index
+   gettingstarted/troubleshooting/index
+
+.. toctree::
+    :caption: Developer Documentation
+    :maxdepth: 2
+
+    developer/build-run-debug/index
+    developer/corearchitecture/index
+    developer/corefeatures/index
+    developer/plugindoc/index
+    developer/plugins/index
+    developer/devicedrivers/index
+    developer/tests/overview
+    developer/extras/index
+
+.. toctree::
+    :caption: Interfacing with VPP
+    :maxdepth: 2
+
+    interfacing/binapi/index
+    interfacing/go/index
+    interfacing/rust/index
+    interfacing/libmemif/index
+
+
+
+.. toctree::
+    :caption: Contributing
+    :maxdepth: 2
+
+    contributing/gitreview
+    contributing/writingdocs
+    contributing/reportingissues/index
+
+
+.. toctree::
+    :caption: Debug CLI
+    :maxdepth: 2
+
+    cli-reference/gettingstarted/index
+    cli-reference/interface/index
+    cli-reference/index
+
+
+.. toctree::
+    :caption: Configuration file
+    :maxdepth: 2
+
+    configuration/config_getting_started
+    configuration/reference
+
+
+About this documentation
+
+::
+
+    VPP Version : __VPP_VERSION__
+    Built on    : __BUILT_ON__