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>
(cherry picked from commit 64ebb5ff13)

doxygen/Makefile

@@ -62,7 +62,8 @@ DOXY_INPUT ?= \
 	$(wildcard $(WS_ROOT)/*.md) \
 	$(wildcard $(DOXY_DIR)/*.md) \
 	$(DOXY_SRC_DIRECTORIES) \
-	$(DOXY_SRC)/plugins
+	$(DOXY_SRC)/plugins \
+	extras
 
 # Strip leading workspace path from input names
 DOXY_INPUT := $(subst $(WS_ROOT)/,,$(DOXY_INPUT))
@@ -73,7 +74,6 @@ DOXY_INPUT := $(subst $(WS_ROOT)/,,$(DOXY_INPUT))
 # there's a DPDK equivalent that conflicts.
 # These must be left-anchored paths for the regexp below to work.
 DOXY_EXCLUDE ?= \
-	$(DOXY_SRC)/vlib/buffer.c \
 	$(DOXY_SRC)/vpp-api/lua
 
 # Generate a regexp for filenames to exclude

doxygen/assets/doxy-vpp.css

@@ -45,3 +45,9 @@ pre {
 a.el {
 	font-family: Consolas, Courier, monospace;
 }
+
+div.fragment {
+	padding: 2px;
+	margin-left: 8px;
+}
+

doxygen/dev_doc.md

@@ -0,0 +1,12 @@
+Developer Documentation    {#dev_doc}
+=======================
+
+Programming notes for developers.
+
+- @subpage test_framework_doc
+- @subpage sample_plugin_doc
+- @subpage api_doc
+- @subpage vapi_doc
+- @subpage acl_hash_lookup
+- @subpage acl_multicore
+- @subpage libmemif_doc

doxygen/doxygen.cfg

@@ -882,7 +882,8 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             = $(ROOT)/doxygen/assets
+IMAGE_PATH             = $(ROOT)/doxygen/assets \
+                         $(ROOT)/extras/libmemif/docs
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program

doxygen/test_framework_doc.md

@@ -3,5 +3,6 @@ Test Framework Documentation    {#test_framework_doc}
 
 PyDoc generated documentation for the "make test" framework is available for the following releases
 
+- [Test framework documentation for VPP 17.10](https://docs.fd.io/vpp/17.10/vpp_make_test/html)
 - [Test framework documentation for VPP 17.04](https://docs.fd.io/vpp/17.04/vpp_make_test/html)
 - [Test framework documentation for VPP 17.01](https://docs.fd.io/vpp/17.01/vpp_make_test/html)

doxygen/user_doc.md

@@ -16,6 +16,4 @@ Several modules provide operational, dataplane-user focused documentation.
 - @subpage span_doc
 - @subpage srv6_doc
 - @subpage srmpls_doc
-- @subpage sample_plugin_doc
 - @subpage nat64_doc
-- @subpage api_doc