From 55c68c9521d98005ce850ee54a40c7579d88928b Mon Sep 17 00:00:00 2001 From: Nathan Skrzypczak Date: Mon, 29 Jul 2019 11:18:05 +0200 Subject: 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 --- docs/gettingstarted/developers/index.rst | 1 + docs/gettingstarted/developers/punt.rst | 1 + docs/scripts/prepare-for-site.sh | 18 ++++++++++++++++++ 3 files changed, 20 insertions(+) create mode 120000 docs/gettingstarted/developers/punt.rst create mode 100755 docs/scripts/prepare-for-site.sh (limited to 'docs') 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 + -- cgit 1.2.3-korg