diff options
| -rw-r--r-- | host/CMakeLists.txt | 15 | ||||
| -rw-r--r-- | host/docs/CMakeLists.txt | 29 | ||||
| -rw-r--r-- | host/docs/mainpage.dox (renamed from host/docs/mainpage.dox.in) | 2 |
3 files changed, 7 insertions, 39 deletions
diff --git a/host/CMakeLists.txt b/host/CMakeLists.txt index 55110e12a..95f110e9e 100644 --- a/host/CMakeLists.txt +++ b/host/CMakeLists.txt @@ -375,21 +375,6 @@ LIBUHD_REGISTER_COMPONENT("Utils" ENABLE_UTILS ON "ENABLE_LIBUHD" OFF OFF) LIBUHD_REGISTER_COMPONENT("Tests" ENABLE_TESTS ON "ENABLE_LIBUHD" OFF OFF) ######################################################################## -# Check for fpga-src submodule -######################################################################## -set(HAS_FPGA_SUBMODULE FALSE) -execute_process( - COMMAND ${PYTHON_EXECUTABLE} -c "import os; print(os.path.abspath(os.path.join('${CMAKE_SOURCE_DIR}', '..', 'fpga-src')))" - OUTPUT_VARIABLE FPGA_SUBMODULE_DIR - OUTPUT_STRIP_TRAILING_WHITESPACE -) -if(EXISTS "${FPGA_SUBMODULE_DIR}/docs/fpga.md") - set(HAS_FPGA_SUBMODULE TRUE) - message(STATUS "") - message(STATUS "Found FPGA submodule: ${FPGA_SUBMODULE_DIR}") -endif(EXISTS "${FPGA_SUBMODULE_DIR}/docs/fpga.md") - -######################################################################## # Add the subdirectories ######################################################################## if(ENABLE_LIBUHD) diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt index 08e4a6766..37d67bb16 100644 --- a/host/docs/CMakeLists.txt +++ b/host/docs/CMakeLists.txt @@ -21,35 +21,18 @@ set(ENABLE_MANUAL_OR_DOXYGEN false) ######################################################################## LIBUHD_REGISTER_COMPONENT("Manual" ENABLE_MANUAL ON "DOXYGEN_FOUND" OFF 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(FPGA_SOURCE_DIR "${CMAKE_SOURCE_DIR}/../fpga") set(ENABLE_MANUAL_OR_DOXYGEN true) - # First: Set up UHD manual only file(GLOB manual_sources "*.dox") + file(GLOB_RECURSE fpga_manual_sources "${FPGA_SOURCE_DIR}/docs/*.md") + list(APPEND manual_sources ${fpga_manual_sources}) set(DOXYGEN_DEPENDENCIES ${manual_sources}) - set(DOXYGEN_INPUT_DIRS "${CMAKE_SOURCE_DIR}/docs ${CMAKE_CURRENT_BINARY_DIR}") + set(DOXYGEN_INPUT_DIRS "${CMAKE_SOURCE_DIR}/docs ${CMAKE_CURRENT_BINARY_DIR} ${FPGA_SOURCE_DIR}/docs") 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 "") + set(DOXYGEN_FPGA_MANUAL_REFERENCE "\\subpage md_fpga \"Part III: FPGA Manual\"") + set(DOXYGEN_STRIP_EXTRA "${CMAKE_SOURCE_DIR}/../fpga/docs") set(DOXYGEN_EXCLUDE_DIRS "") - # 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 md_fpga \"Part III: FPGA Manual\"") - set(DOXYGEN_STRIP_EXTRA "${FPGA_SUBMODULE_DIR}/docs") - endif(HAS_FPGA_SUBMODULE) - configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in - ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox - @ONLY) endif(ENABLE_MANUAL) ######################################################################## diff --git a/host/docs/mainpage.dox.in b/host/docs/mainpage.dox index 4b3371a57..ac2377cde 100644 --- a/host/docs/mainpage.dox.in +++ b/host/docs/mainpage.dox @@ -12,7 +12,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 md_fpga "Part III: FPGA Manual" ### Further Information |