Docs: Add stub of RFNoC docs

5 files changed, 26 insertions, 3 deletions

diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt
index a5f6751bf..8a9c8b7f4 100644
--- a/host/docs/CMakeLists.txt
+++ b/host/docs/CMakeLists.txt
@@ -31,7 +31,7 @@ IF(ENABLE_MANUAL)
     # First: Set up UHD manual only
     FILE(GLOB manual_sources "*.dox")
     SET(DOXYGEN_DEPENDENCIES ${manual_sources})
-    SET(DOXYGEN_INPUT_DIRS "${CMAKE_SOURCE_DIR}/docs")
+    SET(DOXYGEN_INPUT_DIRS "${CMAKE_SOURCE_DIR}/docs ${CMAKE_CURRENT_BINARY_DIR}")
     SET(DOXYGEN_DEP_COMPONENT "manual")
     SET(DOXYGEN_FPGA_MANUAL_REFERENCE "<a href=\"http://files.ettus.com/manual/md_fpga.html\">Part III: FPGA Manual</a>")
     SET(DOXYGEN_STRIP_EXTRA "")
@@ -72,7 +72,7 @@ IF(ENABLE_DOXYGEN)
     FILE(GLOB_RECURSE header_files ${CMAKE_SOURCE_DIR}/include/*.hpp)
     FILE(GLOB_RECURSE h_files ${CMAKE_SOURCE_DIR}/include/*.h)
     LIST(APPEND header_files ${h_files})
-    SET(DOXYGEN_DEPENDENCIES ${DOXYGEN_DEPENDENCIES} ${header_files})
+    SET(DOXYGEN_DEPENDENCIES ${DOXYGEN_DEPENDENCIES} ${header_files} "${CMAKE_SOURCE_DIR}/lib/rfnoc/nocscript/gen_basic_funcs.py")
     IF(ENABLE_DOXYGEN_FULL)
         SET(DOXYGEN_INPUT_DIRS "${DOXYGEN_INPUT_DIRS} ${CMAKE_SOURCE_DIR}/include ${CMAKE_SOURCE_DIR}/lib ${CMAKE_SOURCE_DIR}/python")
     ELSE(ENABLE_DOXYGEN_FULL)
diff --git a/host/docs/Doxyfile.in b/host/docs/Doxyfile.in
index 678ea6b8d..36ae2208c 100644
--- a/host/docs/Doxyfile.in
+++ b/host/docs/Doxyfile.in
@@ -654,7 +654,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = @CMAKE_CURRENT_BINARY_DIR@/mainpage.dox @DOXYGEN_INPUT_DIRS@
+INPUT                  = @DOXYGEN_INPUT_DIRS@
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
diff --git a/host/docs/block_desc_files.dox b/host/docs/block_desc_files.dox
new file mode 100644
index 000000000..20f54e24a
--- /dev/null
+++ b/host/docs/block_desc_files.dox
@@ -0,0 +1,16 @@
+/*! \page page_rfnoc_descriptor_file RFNoC Block Descriptor Files
+
+
+\section rfnoc_descriptor_file_nocscript NocScript
+
+NocScript is a simple DSL designed to augment block definition files for RFNoC.
+
+\li Statically Typed
+\li No implicit typecasting
+\li Very few operators
+
+See \subpage page_nocscript_funcs for a full function reference.
+
+*/
+// vim:ft=doxygen:
+
diff --git a/host/docs/mainpage.dox.in b/host/docs/mainpage.dox.in
index 4b3371a57..ebe509fc8 100644
--- a/host/docs/mainpage.dox.in
+++ b/host/docs/mainpage.dox.in
@@ -13,6 +13,7 @@ Follow these links to get to the section of the manual you wish to consult, or u
 \li \subpage page_devices "Part I: Devices & Usage Manual"
 \li \subpage page_uhd "Part II: UHD Development Manual"
 \li @DOXYGEN_FPGA_MANUAL_REFERENCE@
+\li \subpage page_rfnoc "Part IV: RFNoC Development Manual"
 
 ### Further Information
 
diff --git a/host/docs/rfnoc.dox b/host/docs/rfnoc.dox
new file mode 100644
index 000000000..602b75b46
--- /dev/null
+++ b/host/docs/rfnoc.dox
@@ -0,0 +1,6 @@
+/*! \page page_rfnoc RFNoC Development Manual
+
+\li \subpage page_rfnoc_descriptor_file
+
+*/
+// vim:ft=doxygen: