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

Fixing link to Doxygen #916

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from
Open

Fixing link to Doxygen #916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
54efbce
fixing input source
kab163 Oct 3, 2024
b976fd3
doing stuff
kab163 Oct 3, 2024
ca1c9c1
trying to fix doxygen
kab163 Oct 3, 2024
9963336
trying to get the right path
kab163 Oct 3, 2024
7d74324
trying anything
kab163 Oct 3, 2024
1578df4
trying a different doxygen path in rst
kab163 Oct 3, 2024
3363e50
trying a different cmake command instead
kab163 Oct 3, 2024
bec8387
trying to mimic raja
kab163 Oct 3, 2024
df781f7
using another output dir
kab163 Oct 3, 2024
13a8841
trying more fixes...
kab163 Oct 3, 2024
9db3cf6
trying to fix input source
kab163 Oct 4, 2024
08f64b5
copying some more options from raja
kab163 Oct 4, 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
2 changes: 1 addition & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ cmake_dependent_option( UMPIRE_ENABLE_BENCHMARKS "Build Umpire benchmarks" On
cmake_dependent_option( UMPIRE_ENABLE_EXAMPLES "Build Umpire examples" On
"ENABLE_EXAMPLES" Off )

cmake_dependent_option( UMPIRE_ENABLE_DOCS "Build Umpire docs" Off
cmake_dependent_option( UMPIRE_ENABLE_DOCS "Build Umpire docs" On
"ENABLE_DOCS" Off )
cmake_dependent_option( UMPIRE_ENABLE_CLANGQUERY "Build Umpire with Clang query" On
"ENABLE_CLANGQUERY" Off )
Expand Down
18 changes: 12 additions & 6 deletions docs/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@
#
# SPDX-License-Identifier: (MIT)
##############################################################################
if (DOXYGEN_FOUND)
add_subdirectory(doxygen)
endif ()
if (SPHINX_FOUND)
blt_add_sphinx_target( umpire_docs )
add_subdirectory(sphinx)
endif()

if (SPHINX_FOUND)
add_subdirectory(sphinx)
endif ()
if (DOXYGEN_FOUND)
add_subdirectory(doxygen)
endif ()

if ( NOT SPHINX_FOUND AND NOT DOXGEN_FOUND)
message(WARNING "UMPIRE_ENABLE_DOCS=On, but Sphinx or Doxygen not found. \
Documentation won't be built.")
endif ()
4 changes: 2 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@
# built documents.
#
# The short X.Y version.
version = u'6.0'
version = u'2024.07'
# The full version, including alpha/beta/rc tags.
release = u'6.0.0'
release = u'2024.07.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
11 changes: 11 additions & 0 deletions docs/doxygen/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,14 @@
# SPDX-License-Identifier: (MIT)
##############################################################################
blt_add_doxygen_target( umpire_doxygen )

# Required directory for doxygen to generate output to
add_custom_target( build_doxygen_output_dir
ALL
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/html
)

add_dependencies( umpire_doxygen build_doxygen_output_dir )

add_dependencies(umpire_docs
umpire_doxygen)
Loading
Loading