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, 8 insertions, 8 deletions

diff --git a/docs/usecases/vhost/vhost.rst b/docs/usecases/vhost/vhost.rst
index f62faade306..e5ff59110b7 100644
--- a/docs/usecases/vhost/vhost.rst
+++ b/docs/usecases/vhost/vhost.rst
@@ -12,11 +12,11 @@ refer to `virsh man page <https://linux.die.net/man/1/virsh>`_.
 The image that we use is based on an Ubuntu cloud image downloaded from:
 `Ubuntu Cloud Images <https://cloud-images.ubuntu.com/xenial/current>`_.
 
-All FD.io VPP commands are being run from a su shell. 
+All FD.io VPP commands are being run from a su shell.
 
 .. _vhosttopo:
 
-Topology 
+Topology
 ---------
 
 In this case we will use 2 systems. One system we will be running standard linux, the other will
@@ -45,7 +45,7 @@ this system to verify our connectivity to our VM with ping.
      __/ __/ _ \  (_)__    | | / / _ \/ _ \
      _/ _// // / / / _ \   | |/ / ___/ ___/
      /_/ /____(_)_/\___/   |___/_/  /_/
-    
+
     vpp# clear interfaces
     vpp# show int
                   Name               Idx       State          Counter          Count
@@ -56,7 +56,7 @@ this system to verify our connectivity to our VM with ping.
 
 For more information on the interface commands refer to: :ref:`intcommands`
 
-The next step will be to create the virtual port using the :ref:`createvhostuser` command.
+The next step will be to create the virtual port using the ``createvhostuser`` command.
 This command will create the virtual port in VPP and create a linux socket that the VM will
 use to connect to VPP.
 
@@ -79,7 +79,7 @@ Creating the VPP port:
 Notice the interface **VirtualEthernet0/0/0**. In this example we created the virtual interface as
 a client.
 
-We can get more detail on the vhost connection with the :ref:`showvhost` command.
+We can get more detail on the vhost connection with the ``showvhost`` command.
 
 .. code-block:: console
 
@@ -100,14 +100,14 @@ We can get more detail on the vhost connection with the :ref:`showvhost` command
       protocol features (0x3)
        VHOST_USER_PROTOCOL_F_MQ (0)
        VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
-    
+
      socket filename /tmp/vm00.sock type client errno "No such file or directory"
-    
+
      rx placement:
      tx placement: spin-lock
        thread 0 on vring 0
        thread 1 on vring 0
-    
+
      Memory regions (total 0)
 
 Notice **No such file or directory** and **Memory regions (total 0)**. This is because the