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
Merged

Add doxygen target using cmake-generated doxyfile #4700

Show file tree
Hide file tree
Changes from 1 commit
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 @@ -1139,6 +1139,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
15 changes: 15 additions & 0 deletions doxygen/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
find_package(Doxygen)
if(${DOXYGEN_FOUND})
PhilipFackler marked this conversation as resolved.
Show resolved Hide resolved
set(DOXYGEN_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE ${PROJECT_SOURCE_DIR}/README.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to remove this, since it gives a very strange first page.

Can you modify the config here so that it gives an accessible start page like https://docs.qmcpack.org/doxygen/doxy/index.html ?
The one produced by this PR has a long function(?) list before the classes and files browser.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prckent I believe the issue was with the navigation tree on the left. I like using the README since it gives links to all the relevant things on the web. I addressed the navigation tree issues (and in my opinion it's more useful than the tree in the current published version). Let me know what you think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that if you don't want to see the main page headings in the navigation, they can be removed with:
set(DOXYGEN_TOC_INCLUDE_HEADINGS 0)

set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_TEMPLATE_RELATIONS YES)
set(DOXYGEN_BUILTIN_STL_SUPPORT YES)
set(DOXYGEN_EXTRACT_PRIVATE YES)
set(DOXYGEN_SOURCE_BROWSER YES)
set(DOXYGEN_INTERACTIVE_SVG YES)
set(DOXYGEN_DISTRIBUTE_GROUP_DOC YES)

doxygen_add_docs(qmcpack_doxygen ${PROJECT_SOURCE_DIR}/src
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer

    doxygen_add_docs(qmcpack_doxygen ${PROJECT_SOURCE_DIR}/src)
else()
    message(STATUS "The qmcpack_doxygen target for the QMCPACK developer/API documentation requires (1) doxygen and (2) dot from graphviz.")
endif()

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a message to similar effect

${PROJECT_SOURCE_DIR}/README.md)
endif()