Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doxygen target using cmake-generated doxyfile #4700

Merged
merged 9 commits into from
Sep 24, 2024
+59 −0
Merged

Add doxygen target using cmake-generated doxyfile #4700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0aba682
Add doxygen target using cmake-generated doxyfile
PhilipFackler Aug 14, 2023
534c0d3
Use if(<variable>) pattern
PhilipFackler Aug 16, 2023
b28fc4b
Merge remote-tracking branch 'origin/develop' into add-doxygen-target
PhilipFackler Dec 6, 2023
1aaba7f
Fix main page image and nav tree options
PhilipFackler Dec 7, 2023
9eb5f30
Added status message when doxygen is not found
PhilipFackler Dec 7, 2023
c0398f9
Added cmake-configured config header
PhilipFackler Dec 7, 2023
31aff4d
Merge branch 'develop' into add-doxygen-target
PhilipFackler Dec 12, 2023
271dc5b
Merge branch 'develop' into add-doxygen-target
prckent Sep 19, 2024
744214f
Merge branch 'develop' into add-doxygen-target
ye-luo Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1129,6 +1129,7 @@ message(STATUS "Ready to parse QMCPACK source tree")

add_subdirectory(external_codes)
add_subdirectory(src)
add_subdirectory(doxygen)

if(NOT QMC_BUILD_SANDBOX_ONLY)
if(NOT QMC_NO_SLOW_CUSTOM_TESTING_COMMANDS)
Expand Down
58 changes: 58 additions & 0 deletions doxygen/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
find_package(Doxygen)
if(NOT DOXYGEN_FOUND)
message(STATUS "The qmcpack_doxygen target for the QMCPACK developer/API "
"documentation requires doxygen and (optionally) dot from graphviz."
)
return()
endif()

set(DOXYGEN_PROJECT_NAME QMCPACK)
set(DOXYGEN_FILE_PATTERNS *.h *.cpp *.doc)
set(DOXYGEN_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
set(DOXYGEN_STRIP_FROM_PATH docs src)
set(DOXYGEN_IMAGE_PATH
${PROJECT_SOURCE_DIR}
${PROJECT_SOURCE_DIR}/doxygen/images
"$(DOXYGEN_IMAGE_PATH)"
)
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE ${PROJECT_SOURCE_DIR}/README.md)
set(DOXYGEN_TOC_INCLUDE_HEADINGS 0)
set(DOXYGEN_NUM_PROC_THREADS 0)
set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_TEMPLATE_RELATIONS YES)
set(DOXYGEN_EXTRACT_ALL YES)
set(DOXYGEN_EXTRACT_PRIVATE YES)
set(DOXYGEN_EXTRACT_STATIC YES)
set(DOXYGEN_SOURCE_BROWSER YES)
set(DOXYGEN_SHORT_NAMES YES)
set(DOXYGEN_JAVADOC_AUTOBRIEF YES)
set(DOXYGEN_DOT_IMAGE_FORMAT svg)
set(DOXYGEN_INTERACTIVE_SVG YES)
set(DOXYGEN_DISTRIBUTE_GROUP_DOC YES)
set(DOXYGEN_INLINE_GROUPED_CLASSES YES)
set(DOXYGEN_INLINE_SIMPLE_STRUCTS YES)
set(DOXYGEN_INLINE_SOURCES YES)
set(DOXYGEN_STRIP_CODE_COMMENTS NO)
set(DOXYGEN_HIDE_SCOPE_NAMES YES)
set(DOXYGEN_SHOW_INCLUDE_FILES NO)
set(DOXYGEN_REFERENCED_BY_RELATION YES)
set(DOXYGEN_REFERENCES_RELATION YES)
set(DOXYGEN_VERBATIM_HEADERS NO)
set(DOXYGEN_TOC_EXPAND YES)
set(DOXYGEN_MACRO_EXPANSION YES)
set(DOXYGEN_EXPAND_ONLY_PREDEF YES)
set(DOXYGEN_SEARCH_INCLUDES NO)
set(DOXYGEN_PREDEFINED DOXYGEN_SHOULD_SKIP_THIS)
set(DOXYGEN_DIRECTORY_GRAPH NO)
set(DOXYGEN_HTML_TIMESTAMP YES)
set(DOXYGEN_ENUM_VALUES_PER_LINE 1)
set(DOXYGEN_GENERATE_TAGFILE qmc_doxygen_tags)
set(DOXYGEN_CALL_GRAPH YES)

doxygen_add_docs(qmcpack_doxygen
${PROJECT_SOURCE_DIR}/src
${PROJECT_BINARY_DIR}/src/config.h
${PROJECT_SOURCE_DIR}/README.md
${PROJECT_SOURCE_DIR}/CHANGELOG.md
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
)
Loading