Skip to content

Re-sync Doxyfile with CMake #978

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

Merged
merged 6 commits into from
Jan 17, 2024
Merged

Re-sync Doxyfile with CMake #978

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f81db93
Sort Doxygen lists for comparison purposes
turboencabulator Jan 15, 2024
62c9cd8
Skip setting Doxygen options to default values
turboencabulator Jan 15, 2024
bd6fece
Reset several Doxygen options to their default values
turboencabulator Jan 15, 2024
cf9b217
Add options missing from the existing Doxyfile
turboencabulator Jan 16, 2024
7952995
Adjust Doxygen source and output paths
turboencabulator Jan 16, 2024
55d73a2
Prevent html options from being applied to manpage generation
turboencabulator Jan 16, 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
Prev Previous commit
Prevent html options from being applied to manpage generation 
When both BUILD_HTML_DOCUMENTATION and BUILD_MAN_DOCUMENTATION are ON,
DOXYGEN_GENERATE_HTML was set to YES (and some other HTML-only variables
were set) whenever Doxyfile.man was generated, and therefore `make man`
would also populate DOCS/explore-html, but with less detail due to the
other differences between Doxyfile.man and Doxyfile.html.
  • Loading branch information
@turboencabulator
turboencabulator committed Jan 16, 2024
commit 55d73a2ef29ac755c32c3cc16c2cc51564b6b0dc
13 changes: 8 additions & 5 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -630,8 +630,6 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION)
set(DOXYGEN_INTERACTIVE_SVG YES)
set(DOXYGEN_WARN_NO_PARAMDOC YES)
set(DOXYGEN_WARN_LOGFILE doxygen_error)
set(DOXYGEN_GENERATE_HTML NO)
set(DOXYGEN_GENERATE_MAN NO)
set(DOXYGEN_LAYOUT_FILE "DOCS/DoxygenLayout.xml")

# Exclude functions that are duplicated, creating conflicts.
Expand All @@ -646,12 +644,13 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION)

if (BUILD_HTML_DOCUMENTATION)
set(DOXYGEN_GENERATE_HTML YES)
set(DOXYGEN_HTML_OUTPUT explore-html)
set(DOXYGEN_HTML_TIMESTAMP YES)
set(DOXYGEN_GENERATE_MAN NO)
set(DOXYGEN_INLINE_SOURCES YES)
set(DOXYGEN_CALL_GRAPH YES)
set(DOXYGEN_CALLER_GRAPH YES)

set(DOXYGEN_HTML_OUTPUT explore-html)
set(DOXYGEN_HTML_TIMESTAMP YES)
doxygen_add_docs(
html

Expand All @@ -666,14 +665,17 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION)

COMMENT "Generating html LAPACK documentation (it will take some time... time to grab a coffee)"
)
unset(DOXYGEN_HTML_OUTPUT)
unset(DOXYGEN_HTML_TIMESTAMP)
endif()
if (BUILD_MAN_DOCUMENTATION)
set(DOXYGEN_GENERATE_HTML NO)
set(DOXYGEN_GENERATE_MAN YES)
set(DOXYGEN_MAN_LINKS YES)
set(DOXYGEN_INLINE_SOURCES NO)
set(DOXYGEN_CALL_GRAPH NO)
set(DOXYGEN_CALLER_GRAPH NO)

set(DOXYGEN_MAN_LINKS YES)
doxygen_add_docs(
man

Expand All @@ -687,6 +689,7 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION)

COMMENT "Generating man LAPACK documentation"
)
unset(DOXYGEN_MAN_LINKS)
endif()

endif()
Expand Down