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, 20 insertions, 25 deletions

diff --git a/README.md b/README.md
index 4cc283b5e53..05036807610 100644
--- a/README.md
+++ b/README.md
@@ -19,32 +19,32 @@ For more information on VPP and its features please visit the
 ## Changes
 
 Details of the changes leading up to this version of VPP can be found under
-@ref release_notes.
+doc/releasenotes.
 
 
 ## Directory layout
 
 | Directory name         | Description                                 |
 | ---------------------- | ------------------------------------------- |
-|      build-data        | Build metadata                              |
-|      build-root        | Build output directory                      |
-|      doxygen           | Documentation generator configuration       |
-|      dpdk              | DPDK patches and build infrastructure       |
-| @ref extras/libmemif   | Client library for memif                    |
-| @ref src/examples      | VPP example code                            |
-| @ref src/plugins       | VPP bundled plugins directory               |
-| @ref src/svm           | Shared virtual memory allocation library    |
-|      src/tests         | Standalone tests (not part of test harness) |
-|      src/vat           | VPP API test program                        |
-| @ref src/vlib          | VPP application library                     |
-| @ref src/vlibapi       | VPP API library                             |
-| @ref src/vlibmemory    | VPP Memory management                       |
-| @ref src/vnet          | VPP networking                              |
-| @ref src/vpp           | VPP application                             |
-| @ref src/vpp-api       | VPP application API bindings                |
-| @ref src/vppinfra      | VPP core library                            |
-| @ref src/vpp/api       | Not-yet-relocated API bindings              |
-|      test              | Unit tests and Python test harness          |
+| build-data             | Build metadata                              |
+| build-root             | Build output directory                      |
+| docs                   | Sphinx Documentation                        |
+| dpdk                   | DPDK patches and build infrastructure       |
+| extras/libmemif        | Client library for memif                    |
+| src/examples           | VPP example code                            |
+| src/plugins            | VPP bundled plugins directory               |
+| src/svm                | Shared virtual memory allocation library    |
+| src/tests              | Standalone tests (not part of test harness) |
+| src/vat                | VPP API test program                        |
+| src/vlib               | VPP application library                     |
+| src/vlibapi            | VPP API library                             |
+| src/vlibmemory         | VPP Memory management                       |
+| src/vnet               | VPP networking                              |
+| src/vpp                | VPP application                             |
+| src/vpp-api            | VPP application API bindings                |
+| src/vppinfra           | VPP core library                            |
+| src/vpp/api            | Not-yet-relocated API bindings              |
+| test                   | Unit tests and Python test harness          |
 
 ## Getting started
 
@@ -99,8 +99,3 @@ end-user-oriented information. Also see @subpage dev_doc for developer notes.
 Visit the [VPP wiki](https://wiki.fd.io/view/VPP) for details on more
 advanced building strategies and other development notes.
 
-
-## Test Framework
-
-There is PyDoc generated documentation available for the VPP test framework.
-See @ref test_framework_doc for details.