aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorNathan Skrzypczak <nathan.skrzypczak@gmail.com>2019-07-29 11:18:05 +0200
committerDave Barach <openvpp@barachs.net>2019-08-01 18:01:57 +0000
commit55c68c9521d98005ce850ee54a40c7579d88928b (patch)
treeb5513b058e87e9914c13e5f08df5787f2b595fa8 /docs
parent30aaf97a90230d68c0f2736b0a026e07b06e7e32 (diff)
docs: Small fixes and ordering
* deactivtates the TODOs on doxygen (were empty) * This move punt.md to readthedocs (should be the new place for dev doc ?) * Makes Handoff queue demo plugin a child of dev doc in doxygen Type: fix Change-Id: I1f0476a911b35208212af8dd608bc76160efd22a Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/gettingstarted/developers/index.rst1
l---------docs/gettingstarted/developers/punt.rst1
-rwxr-xr-xdocs/scripts/prepare-for-site.sh18
3 files changed, 20 insertions, 0 deletions
diff --git a/docs/gettingstarted/developers/index.rst b/docs/gettingstarted/developers/index.rst
index 4f2c38d130a..fe265786e24 100644
--- a/docs/gettingstarted/developers/index.rst
+++ b/docs/gettingstarted/developers/index.rst
@@ -38,3 +38,4 @@ The Developers section covers the following areas:
eventviewer
fib20/index.rst
buildwireshark
+ punt
diff --git a/docs/gettingstarted/developers/punt.rst b/docs/gettingstarted/developers/punt.rst
new file mode 120000
index 00000000000..0a56632f671
--- /dev/null
+++ b/docs/gettingstarted/developers/punt.rst
@@ -0,0 +1 @@
+../../../src/vnet/ip/punt.rst \ No newline at end of file
diff --git a/docs/scripts/prepare-for-site.sh b/docs/scripts/prepare-for-site.sh
new file mode 100755
index 00000000000..15888ba6e83
--- /dev/null
+++ b/docs/scripts/prepare-for-site.sh
@@ -0,0 +1,18 @@
+#!/bin/bash
+
+if [ ! -d "docs" ]; then
+ echo "This script is meant to be run from the root directory"
+ exit 1;
+fi
+
+for f in $(find ./docs -type l)
+do
+ target=$(readlink $f)
+ rm $f
+ cp $(dirname $f)/$target $(dirname $f)/$(basename $target)
+ echo "Replaced symlink $f"
+done
+
+echo "Cleaning doc build directory"
+make docs-clean
+