diff options
| author |   Dave Wallace <dwallacelf@gmail.com> | 2017-02-17 00:10:53 -0500 |
|---|---|---|
| committer |   Dave Barach <openvpp@barachs.net> | 2017-02-22 12:57:28 +0000 |
| commit | c8c5335e3a1d1ba7ec1248b0ecbf00cc74ea57bb (patch) | |
| tree | 5a203afbf723e8b9494d73623c3ec16282df268f | |
| parent | 2d41f169c818219b5e8b23ed32e28ef334f39c35 (diff) | |
Add ref to test framework docs in doxygen output.
Change-Id: If3081c4a9dde00cd522d1fc5a7daa9b1849684bf
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | doxygen/Makefile | 6 | ||||
| -rw-r--r-- | doxygen/test_framework_doc.md | 7 |
3 files changed, 14 insertions, 7 deletions
diff --git a/README.md b/README.md index 8520b395f85..b70103fb1fc 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,6 @@ Directory name | Description build-root | Build output directory doxygen | Documentation generator configuration dpdk | DPDK patches and build infrastructure -@ref plugins | Not-yet-relocated VPP bundled plugins directory @ref src | VPP source code @ref src/plugins | VPP bundled plugins directory @ref src/svm | Shared virtual memory allocation library @@ -45,7 +44,7 @@ Directory name | Description @ref src/vpp-api | VPP application API bindings @ref src/vppinfra | VPP core library test | Unit tests -@ref vpp-api | Not-yet-relocated API bindings +@ref src/vpp/api | Not-yet-relocated API bindings ## Getting started @@ -100,3 +99,8 @@ information. Visit the [VPP wiki](https://wiki.fd.io/view/VPP) for details on more advanced building strategies and development notes. + + +## Test Framework + +There is PyDoc generated documentation available for the VPP test framework. See @subpage test_framework_doc for details. diff --git a/doxygen/Makefile b/doxygen/Makefile index 069d97fb864..973ca07facc 100644 --- a/doxygen/Makefile +++ b/doxygen/Makefile @@ -82,10 +82,6 @@ DOXY_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(DOXY_EXCLUDE))' | se # Include all the normal source directories in the include file path DOXY_INCLUDE_PATH = $(DOXY_SRC_DIRECTORIES) -# Also include any plugin directories that exist -DOXY_INCLUDE_PATH += \ - $(shell find $(WS_ROOT)/plugins -maxdepth 1 -type d | sed -e 's@^$(WS_ROOT)/*@@') - # Find API header directories and include them in the header path. # This is only useful if VPP and plugins are already built; nothing # here depends on those targets. We don't build documentation for these @@ -140,7 +136,7 @@ ifeq ($(OS_ID),ubuntu) sudo apt-get $(CONFIRM) $(FORCE) install $$inst; \ fi @if [ ! -s /usr/lib/graphviz/config6a ]; then \ - echo "Rebuidlding system Graphviz configuration."; \ + echo "Rebuilding system Graphviz configuration."; \ sudo dot -c; \ fi else ifneq ("$(wildcard /etc/redhat-release)","") diff --git a/doxygen/test_framework_doc.md b/doxygen/test_framework_doc.md new file mode 100644 index 00000000000..b2873c5fe1b --- /dev/null +++ b/doxygen/test_framework_doc.md @@ -0,0 +1,7 @@ +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.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) |