aboutsummaryrefslogtreecommitdiffstats
path: root/doxygen
diff options
context:
space:
mode:
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 954191eb75c..0a69c2dfe21 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 00000000000..b08ac86a74e
--- /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