aboutsummaryrefslogtreecommitdiffstats
path: root/doxygen
diff options
context:
space:
mode:
authorChris Luke <chrisy@flirble.org>2016-09-14 12:42:54 -0400
committerDamjan Marion <dmarion.lists@gmail.com>2016-09-20 10:53:04 +0000
commit5ccbaa97a86715bfee2ab44523075a93a8abb698 (patch)
treeed6b0b9dd2a65e5fc557cd4f07623da2e41bb7b7 /doxygen
parenta8cd30937e5dc8a3bf629e1ee667550e267e5651 (diff)
Add structure to some of the documentation; VPP-223
Moves the random .md files, when rendered by Doxygen, into a config examples tree. We may later flesh this out into a more complete user documentation section. Change-Id: If423b82f1047f1c84f90876a786313054b5f7c77 Signed-off-by: Chris Luke <chrisy@flirble.org>
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/Makefile6
-rw-r--r--doxygen/user_doc.md10
2 files changed, 15 insertions, 1 deletions
diff --git a/doxygen/Makefile b/doxygen/Makefile
index 954191eb..0a69c2df 100644
--- a/doxygen/Makefile
+++ b/doxygen/Makefile
@@ -40,10 +40,14 @@ DOXY_SRC_DIRECTORIES = \
# Input directories and files
DOXY_INPUT ?= \
- README.md \
+ $(wildcard $(WS_ROOT)/*.md) \
+ $(wildcard $(DOXY_DIR)/*.md) \
$(DOXY_SRC_DIRECTORIES) \
plugins
+# Strip leading workspace path from input names
+DOXY_INPUT := $(subst $(WS_ROOT)/,,$(DOXY_INPUT))
+
# Files to exclude, from pre-Doxygen steps, eg because they're
# selectively compiled.
# Examples would be to exclude non-DPDK related sources when
diff --git a/doxygen/user_doc.md b/doxygen/user_doc.md
new file mode 100644
index 00000000..b08ac86a
--- /dev/null
+++ b/doxygen/user_doc.md
@@ -0,0 +1,10 @@
+User Configuration Examples {#user_doc}
+===========================
+
+Several modules provide operational documentation.
+
+- @subpage ipsec_gre_doc
+- @subpage map_doc
+- @subpage lldp_doc
+- @subpage ioam_plugin_doc
+- @subpage lb_plugin_doc