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>

diff --git a/docs/gettingstarted/developers/index.rst b/docs/gettingstarted/developers/index.rst
index 4f2c38d..fe26578 100644 (file)
--- 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 (symlink)
index 0000000..0a56632
--- /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 (executable)
index 0000000..15888ba
--- /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
+

diff --git a/doxygen/dev_doc.md b/doxygen/dev_doc.md
index 2e452d0..00f6cae 100644 (file)
--- a/doxygen/dev_doc.md
+++ b/doxygen/dev_doc.md
@@ -16,3 +16,4 @@ Programming notes for developers.
 - @subpage stats_doc
 - @subpage if_stats_client_doc
 - @subpage api_lang_doc
+- @subpage handoff_queue_demo_plugin
\ No newline at end of file

diff --git a/doxygen/doxygen.cfg b/doxygen/doxygen.cfg
index 39a918f..08356f4 100644 (file)
--- a/doxygen/doxygen.cfg
+++ b/doxygen/doxygen.cfg
@@ -622,7 +622,7 @@ STRICT_PROTO_MATCHING  = NO
 # list. This list is created by putting \todo commands in the documentation.
 # The default value is: YES.
 
-GENERATE_TODOLIST      = YES
+GENERATE_TODOLIST      = NO
 
 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
 # list. This list is created by putting \test commands in the documentation.

diff --git a/src/examples/handoffdemo/README.md b/src/examples/handoffdemo/README.md
index 3787731..e38c7b3 100644 (file)
--- a/src/examples/handoffdemo/README.md
+++ b/src/examples/handoffdemo/README.md
@@ -1,4 +1,4 @@
-# Handoff queue demo plugin
+# Handoff queue demo plugin {#handoff_queue_demo_plugin}
 
 This plugin provides a simplified example of how to hand off
 packets between threads. I used it to debug packet-tracer handoff

diff --git a/src/vnet/ip/punt.md b/src/vnet/ip/punt.rst
similarity index 92%
rename from src/vnet/ip/punt.md
rename to src/vnet/ip/punt.rst
index 2bbb5f6..3f1a9d4 100644 (file)
--- a/src/vnet/ip/punt.md
+++ b/src/vnet/ip/punt.rst
@@ -1,10 +1,10 @@
-.. _punt:
+.. _dev_punt:
+
+.. toctree::
 
 Punting Packets
 ===============
 
-.. toctree::
-
 Overview
 ________
 
@@ -17,8 +17,8 @@ A popular meaning of punt is to send packets to the user/control-plane.
 This is specific option of the more general case above, where VPP is
 handing the packet to the control-plane for further prosessing.
 
-The Punt Infrastructe
----------------------
+The Punt Infrastructure
+_______________________
 
 Exception packets are those that a given node cannot handle via normal
 mecahnisms.
@@ -37,7 +37,7 @@ that the source node would otherise drop.
 
 
 Punting to the Control Plane
-----------------------------
+____________________________
 
 Active Punt
 -----------
@@ -47,11 +47,10 @@ want to receive and this is where I want it sent.
 
 Currently there exists 3 ways to describe how to match/classify the
 packets to be punted:
-...
- 1) a matching UDP port
- 2) a matching IP protocol (i.e. OSPF)
- 3) a matching punt excpetion reason (see above)
-...
+
+1) a matching UDP port
+2) a matching IP protocol (i.e. OSPF)
+3) a matching punt excpetion reason (see above)
 
 Depending on the type/classification of the packet to be punted, that
 active punt will register itself into the VLIB graph to receive those