Skip to content

Commit

Permalink
Added build for Doxygen docs
Browse files Browse the repository at this point in the history
Build workflow will generate html files from source if Doxygen is present.
Signed-off-by: Tammy Leino <[email protected]>
  • Loading branch information
tammyleino authored and arnopo committed Dec 14, 2022
1 parent 081172c commit c1f93a1
Show file tree
Hide file tree
Showing 22 changed files with 5,181 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,7 @@ add_subdirectory (lib)
if (WITH_APPS)
add_subdirectory (apps)
endif (WITH_APPS)

if (WITH_DOC)
add_subdirectory (doc)
endif (WITH_DOC)
2,769 changes: 2,769 additions & 0 deletions Doxyfile

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions cmake/depends.cmake
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
if (WITH_DOC)
find_package (Doxygen)
endif (WITH_DOC)

if (WITH_LIBMETAL_FIND)
find_package (Libmetal REQUIRED)
collect (PROJECT_INC_DIRS "${LIBMETAL_INCLUDE_DIR}")
Expand Down
2 changes: 2 additions & 0 deletions cmake/options.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,6 @@ if (DEFINED RPMSG_BUFFER_SIZE)
add_definitions( -DRPMSG_BUFFER_SIZE=${RPMSG_BUFFER_SIZE} )
endif (DEFINED RPMSG_BUFFER_SIZE)

option (WITH_DOC "Build with documentation" OFF)

message ("-- C_FLAGS : ${CMAKE_C_FLAGS}")
17 changes: 17 additions & 0 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
if (DOXYGEN_FOUND)

configure_file (Doxyfile.in Doxyfile @ONLY)

add_custom_target (doc ALL
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)

install (DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
DESTINATION share/doc/${PROJECT_NAME})
install (FILES ${PROJECT_SOURCE_DIR}/README.md
DESTINATION share/doc/${PROJECT_NAME})
install (FILES ${PROJECT_SOURCE_DIR}/LICENSE.md
DESTINATION share/doc/${PROJECT_NAME})

endif (DOXYGEN_FOUND)
2,385 changes: 2,385 additions & 0 deletions doc/Doxyfile.in

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added doc/openamp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes.

0 comments on commit c1f93a1

Please sign in to comment.