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

Add a flag to make doxygen HTML generation optional. #450

Merged
merged 1 commit into from
May 18, 2021
Merged

Add a flag to make doxygen HTML generation optional. #450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions docs/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,21 @@ option(DPCTL_USE_MULTIVERSION_TEMPLATE
OFF
)

# Option to generate HTML from dpxygen
option(DPCTL_ENABLE_DOXYGEN_HTML
"Enable generation of html files for C API using Doxygen"
OFF
)

# This function defines everything needed to generate Doxygen docs
function(_setup_doxygen)
# We generate doxygen only for the public headers to keep the Doxyrest
# generated rst files clean.
# FIXME: make it possible to generate doxygen for all files.
set(GENERATE_HTML "NO")
if(DPCTL_ENABLE_DOXYGEN_HTML)
set(GENERATE_HTML "YES")
endif()
set(DOXYGEN_INPUT_DIR ../dpctl-capi/include)
set(DOXYGEN_OUTPUT_DIR ${DOC_OUTPUT_DIR}/doxygen)
set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml)
Expand Down
2 changes: 1 addition & 1 deletion docs/Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1180,7 +1180,7 @@ IGNORE_PREFIX =
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.

GENERATE_HTML = YES
GENERATE_HTML = @GENERATE_HTML@

# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
Expand Down