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>

6 files changed, 20 insertions, 21 deletions

diff --git a/docs/usecases/vhost/index.rst b/docs/usecases/vhost/index.rst
index 002ebc17639..dd189b467e0 100644
--- a/docs/usecases/vhost/index.rst
+++ b/docs/usecases/vhost/index.rst
@@ -1,7 +1,7 @@
 .. _vhost:
 
-FD.io VPP with Virtual Machines
-===============================
+VPP with Virtual Machines
+=========================
 This chapter will describe how to use FD.io VPP with virtual machines. We describe
 how to create Vhost port with VPP and how to connect them to VPP. We will also discuss
 some limitations of Vhost.
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
diff --git a/docs/usecases/vhost/vhost02.rst b/docs/usecases/vhost/vhost02.rst
index d316463c15a..17bbafc854f 100644
--- a/docs/usecases/vhost/vhost02.rst
+++ b/docs/usecases/vhost/vhost02.rst
@@ -3,8 +3,7 @@
 Creating the Virtual Machine
 ----------------------------
 
-We will now create the virtual machine. We use the "virsh create command". For the complete file we
-use refer to :ref:`xmlexample`.
+We will now create the virtual machine. We use the "virsh create command".
 
 It is important to note that in the XML file we specify the socket path that is used to connect to
 FD.io VPP.
@@ -85,26 +84,26 @@ and in the example.
       protocol features (0x3)
        VHOST_USER_PROTOCOL_F_MQ (0)
        VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
-    
+
      socket filename /tmp/vm00.sock type client errno "Success"
-    
+
      rx placement:
        thread 1 on vring 1, polling
      tx placement: spin-lock
        thread 0 on vring 0
        thread 1 on vring 0
-    
+
      Memory regions (total 2)
      region fd    guest_phys_addr    memory_size        userspace_addr     mmap_offset        mmap_addr
      ====== ===== ================== ================== ================== ================== ===============    ===
       0     31    0x0000000000000000 0x00000000000a0000 0x00007f1db9c00000 0x0000000000000000 0x00007f7db0400    000
       1     32    0x00000000000c0000 0x000000000ff40000 0x00007f1db9cc0000 0x00000000000c0000 0x00007f7d94ec0    000
-    
+
      Virtqueue 0 (TX)
       qsz 1024 last_avail_idx 0 last_used_idx 0
       avail.flags 0 avail.idx 256 used.flags 1 used.idx 0
       kickfd 33 callfd 34 errfd -1
-    
+
      Virtqueue 1 (RX)
       qsz 1024 last_avail_idx 8 last_used_idx 8
       avail.flags 0 avail.idx 8 used.flags 1 used.idx 8
diff --git a/docs/usecases/vhost/vhost03.rst b/docs/usecases/vhost/vhost03.rst
index ed583349bc6..05d1fd1fb11 100644
--- a/docs/usecases/vhost/vhost03.rst
+++ b/docs/usecases/vhost/vhost03.rst
@@ -17,7 +17,7 @@ Use the "set interface l2 bridge" command.
     vpp# show bridge 100 det
       BD-ID   Index   BSN  Age(min)  Learning  U-Forwrd  UU-Flood  Flooding  ARP-Term  BVI-Intf
        100      1      0     off        on        on        on        on       off       N/A
-    
+
                Interface           If-idx ISN  SHG  BVI  TxFlood        VLAN-Tag-Rewrite
          VirtualEthernet0/0/0        3     1    0    -      *                 none
        TenGigabitEthernet86/0/0      1     1    0    -      *                 none
@@ -85,4 +85,4 @@ system as **tx packets**. The reverse is true on the way in.
                                                          tx packets                    16
                                                          tx bytes                    1476
     local0                            0        down
-    vpp# 
+    vpp#
diff --git a/docs/usecases/vhost/vhost04.rst b/docs/usecases/vhost/vhost04.rst
index 256c0b8ffa4..02e05bc66bf 100644
--- a/docs/usecases/vhost/vhost04.rst
+++ b/docs/usecases/vhost/vhost04.rst
@@ -11,7 +11,7 @@ Destroy the VMs with "virsh destroy"
      Id    Name                           State
     ----------------------------------------------------
      65    iperf-server3                  running
-    
+
     cto@tf-ucs-3:~$ virsh destroy iperf-server3
     Domain iperf-server3 destroyed
 
diff --git a/docs/usecases/vhost/vhost05.rst b/docs/usecases/vhost/vhost05.rst
index 4eba6e17101..c7c80d55831 100644
--- a/docs/usecases/vhost/vhost05.rst
+++ b/docs/usecases/vhost/vhost05.rst
@@ -11,7 +11,7 @@ VPP performance with vHost is limited by the Qemu vHost driver. FD.io VPP 18.04
 shows with 2 threads, 2 cores and a Queue size of 1024 the maximum NDR throughput was about 7.5 Mpps.
 This is about the limit at this time.
 
-For all the details on the CSIT VM vhost connection refer to the 
+For all the details on the CSIT VM vhost connection refer to the
 `CSIT VM vHost performance tests <https://docs.fd.io/csit/rls1804/report/vpp_performance_tests/packet_throughput_graphs/vm_vhost.html>`_.