From 925bd26d3a66de434f32ac69599564dc2f5bc69d Mon Sep 17 00:00:00 2001 From: Martin Braun Date: Fri, 24 Apr 2015 18:13:58 -0700 Subject: docs: Added FPGA manual The actual FPGA manual pages are in the FPGA repository. Only if the submodule is checked out will it build the manual pages. If the submodule is not checked out, it will create a link to the FPGA manual hosted online. --- host/docs/CMakeLists.txt | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'host/docs/CMakeLists.txt') diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt index 84ed88281..9540ef28e 100644 --- a/host/docs/CMakeLists.txt +++ b/host/docs/CMakeLists.txt @@ -31,12 +31,33 @@ SET(ENABLE_MANUAL_OR_DOXYGEN false) MESSAGE(STATUS "") LIBUHD_REGISTER_COMPONENT("Manual" ENABLE_MANUAL ON "DOXYGEN_FOUND" OFF) +# Check if fpga submodule is there. If yes: +# - Add fpga-src/docs and fpga-src/README.md to inputs +# - Add fpga-src docs dirs to strip? +# If no: +# - Make FPGA Manual reference link to our website + IF(ENABLE_MANUAL) SET(ENABLE_MANUAL_OR_DOXYGEN true) + # 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") SET(DOXYGEN_DEP_COMPONENT "manual") + SET(DOXYGEN_FPGA_MANUAL_REFERENCE "Part III: FPGA Manual") + # Now, check if we have the FPGA sources as well. + # If so, pull them in: + IF(HAS_FPGA_SUBMODULE) + FILE(GLOB_RECURSE fpga_manual_sources "${FPGA_SUBMODULE_DIR}/docs/*.md") + LIST(APPEND manual_sources ${fpga_manual_sources}) + SET(DOXYGEN_INPUT_DIRS "${DOXYGEN_INPUT_DIRS} ${FPGA_SUBMODULE_DIR}/docs") + SET(DOXYGEN_FPGA_MANUAL_REFERENCE "\\subpage page_fpga \"Part III: FPGA Manual\"") + ENDIF(HAS_FPGA_SUBMODULE) + message(STATUS ${manual_sources}) + CONFIGURE_FILE( + ${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in + ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox + @ONLY) ENDIF(ENABLE_MANUAL) ######################################################################## -- cgit v1.2.3 From 4efa67ffcdedd68f77d8df439d433597a5744059 Mon Sep 17 00:00:00 2001 From: Martin Braun Date: Thu, 30 Apr 2015 11:27:39 -0700 Subject: docs: Track doc updates on fpga-src --- host/docs/CMakeLists.txt | 4 +++- host/docs/Doxyfile.in | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) (limited to 'host/docs/CMakeLists.txt') diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt index 9540ef28e..a73d39356 100644 --- a/host/docs/CMakeLists.txt +++ b/host/docs/CMakeLists.txt @@ -45,13 +45,15 @@ IF(ENABLE_MANUAL) SET(DOXYGEN_INPUT_DIRS "${CMAKE_SOURCE_DIR}/docs") SET(DOXYGEN_DEP_COMPONENT "manual") SET(DOXYGEN_FPGA_MANUAL_REFERENCE "Part III: FPGA Manual") + SET(DOXYGEN_STRIP_EXTRA "") # Now, check if we have the FPGA sources as well. # If so, pull them in: IF(HAS_FPGA_SUBMODULE) FILE(GLOB_RECURSE fpga_manual_sources "${FPGA_SUBMODULE_DIR}/docs/*.md") LIST(APPEND manual_sources ${fpga_manual_sources}) SET(DOXYGEN_INPUT_DIRS "${DOXYGEN_INPUT_DIRS} ${FPGA_SUBMODULE_DIR}/docs") - SET(DOXYGEN_FPGA_MANUAL_REFERENCE "\\subpage page_fpga \"Part III: FPGA Manual\"") + SET(DOXYGEN_FPGA_MANUAL_REFERENCE "\\subpage md_fpga \"Part III: FPGA Manual\"") + SET(DOXYGEN_STRIP_EXTRA "${FPGA_SUBMODULE_DIR}/docs") ENDIF(HAS_FPGA_SUBMODULE) message(STATUS ${manual_sources}) CONFIGURE_FILE( diff --git a/host/docs/Doxyfile.in b/host/docs/Doxyfile.in index bca3b71d1..0f0a5cc27 100644 --- a/host/docs/Doxyfile.in +++ b/host/docs/Doxyfile.in @@ -132,7 +132,7 @@ FULL_PATH_NAMES = YES # relative paths, which will be relative from the directory where doxygen is # started. -STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@ @FPGA_SUBMODULE_DIR@ +STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@ @DOXYGEN_STRIP_EXTRA@ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells -- cgit v1.2.3 From dd3e56965ed9f60aee1cb1cc88593fb41bf2bc02 Mon Sep 17 00:00:00 2001 From: Martin Braun Date: Thu, 30 Apr 2015 12:38:42 -0700 Subject: docs: Removed stray CMake message --- host/docs/CMakeLists.txt | 1 - 1 file changed, 1 deletion(-) (limited to 'host/docs/CMakeLists.txt') diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt index a73d39356..eb4b67c29 100644 --- a/host/docs/CMakeLists.txt +++ b/host/docs/CMakeLists.txt @@ -55,7 +55,6 @@ IF(ENABLE_MANUAL) SET(DOXYGEN_FPGA_MANUAL_REFERENCE "\\subpage md_fpga \"Part III: FPGA Manual\"") SET(DOXYGEN_STRIP_EXTRA "${FPGA_SUBMODULE_DIR}/docs") ENDIF(HAS_FPGA_SUBMODULE) - message(STATUS ${manual_sources}) CONFIGURE_FILE( ${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox -- cgit v1.2.3