General documentation updates

- We now have several developer-focused docs, so create an index page
  for them.
- Rework several docs to fit into the index structure.
- Experiment with code highlighting; tweak the CSS slightly to make
  it slightly nicer to look at.

Change-Id: I4185a18f84fa0764745ca7a3148276064a3155c6
Signed-off-by: Chris Luke <chrisy@flirble.org>
This commit is contained in:
Chris Luke
2017-09-27 15:09:48 -04:00
committed by Florin Coras
parent 4ff586d1c6
commit 64ebb5ff13
16 changed files with 117 additions and 83 deletions

View File

@ -30,10 +30,11 @@ Directory name | Description
build-root | Build output directory
doxygen | Documentation generator configuration
dpdk | DPDK patches and build infrastructure
@ref src | VPP source code
@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 | Unit tests
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
@ -43,9 +44,8 @@ Directory name | Description
@ref src/vpp | VPP application
@ref src/vpp-api | VPP application API bindings
@ref src/vppinfra | VPP core library
test | Unit tests
@ref src/vpp/api | Not-yet-relocated API bindings
@ref src/examples | VPP example code
test | Unit tests and Python test harness
## Getting started
@ -95,12 +95,13 @@ for this can be found [on the Setting up Vagrant wiki page]
## More information
Several modules provide documentation, see @subpage user_doc for more
information.
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 development notes.
advanced building strategies and other development notes.
## Test Framework
There is PyDoc generated documentation available for the VPP test framework. See @subpage test_framework_doc for details.
There is PyDoc generated documentation available for the VPP test framework.
See @ref test_framework_doc for details.