michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: doxygen: provide a way to override configs locally

Browse source 
This allows specifying the environment variable
ZEPHYR_DOXYGEN_OVERLAY pointing to a overlay file for
doxygen to override configs in the base zephyr.doxyfile.in
for local document builds.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
This commit is contained in:
Daniel Leung 2024-06-18 11:40:43 -07:00 • committed by Anas Nashif
commit bd2fc8009b
2 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/CMakeLists.txt
View file

@ -47,6 +47,16 @@ set(SPHINX_ENV
DOT_EXECUTABLE=${DOXYGEN_DOT_EXECUTABLE} DOT_EXECUTABLE=${DOXYGEN_DOT_EXECUTABLE}
) )
if(DEFINED ENV{ZEPHYR_DOXYGEN_OVERLAY})
if(EXISTS $ENV{ZEPHYR_DOXYGEN_OVERLAY})
set(INCLUDE_CUSTOM_FILE "@INCLUDE = $ENV{ZEPHYR_DOXYGEN_OVERLAY}")
else()
message(FATAL_ERROR "Zephyr Doxygen overlay $ENV{ZEPHYR_DOXYGEN_OVERLAY} does not exist!")
endif()
else()
set(INCLUDE_CUSTOM_FILE "")
endif()
set(DOCS_CFG_DIR ${CMAKE_CURRENT_LIST_DIR}) set(DOCS_CFG_DIR ${CMAKE_CURRENT_LIST_DIR})
set(DOCS_DOCTREE_DIR ${CMAKE_CURRENT_BINARY_DIR}/doctrees) set(DOCS_DOCTREE_DIR ${CMAKE_CURRENT_BINARY_DIR}/doctrees)
set(DOCS_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}) set(DOCS_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR})

2
doc/zephyr.doxyfile.in
View file

@ -2816,3 +2816,5 @@ GENERATE_LEGEND = YES
# The default value is: YES. # The default value is: YES.
DOT_CLEANUP = YES DOT_CLEANUP = YES
@INCLUDE_CUSTOM_FILE@