summaryrefslogtreecommitdiffstats
path: root/doxygen
diff options
context:
space:
mode:
authorChris Luke <chrisy@flirble.org>2017-09-27 15:09:48 -0400
committerFlorin Coras <florin.coras@gmail.com>2017-09-28 01:47:14 +0000
commitd84f2ef54a457918f21bb0ee82392274b62611fe (patch)
tree9977c9644b6a8c32d4eb19a1328050cfd1d339e5 /doxygen
parent7ea28045aabf29f6ed50894fc23f2e7166297614 (diff)
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 64ebb5ff1338140d94c7f9ee72138fe84d89de2e)
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/Makefile4
-rw-r--r--doxygen/assets/doxy-vpp.css6
-rw-r--r--doxygen/dev_doc.md12
-rw-r--r--doxygen/doxygen.cfg3
-rw-r--r--doxygen/test_framework_doc.md1
-rw-r--r--doxygen/user_doc.md2
6 files changed, 23 insertions, 5 deletions
diff --git a/doxygen/Makefile b/doxygen/Makefile
index b6ba5887666..5870530f92c 100644
--- a/doxygen/Makefile
+++ b/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
diff --git a/doxygen/assets/doxy-vpp.css b/doxygen/assets/doxy-vpp.css
index 3b74eb6f66b..108600acefc 100644
--- a/doxygen/assets/doxy-vpp.css
+++ b/doxygen/assets/doxy-vpp.css
@@ -45,3 +45,9 @@ pre {
a.el {
font-family: Consolas, Courier, monospace;
}
+
+div.fragment {
+ padding: 2px;
+ margin-left: 8px;
+}
+
diff --git a/doxygen/dev_doc.md b/doxygen/dev_doc.md
new file mode 100644
index 00000000000..d1d22f76140
--- /dev/null
+++ b/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
diff --git a/doxygen/doxygen.cfg b/doxygen/doxygen.cfg
index 7675b693962..f2d39112bde 100644
--- a/doxygen/doxygen.cfg
+++ b/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
diff --git a/doxygen/test_framework_doc.md b/doxygen/test_framework_doc.md
index b2873c5fe1b..755a29e41f4 100644
--- a/doxygen/test_framework_doc.md
+++ b/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)
diff --git a/doxygen/user_doc.md b/doxygen/user_doc.md
index 65b09f98c9e..f7d7936b3f3 100644
--- a/doxygen/user_doc.md
+++ b/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