Skip to content

Commit

Permalink
Doxygen auto-download feature removed. (#141)
Browse files Browse the repository at this point in the history
-  Automatic downloading of Doxygen is no longer supported by CMake

Co-authored-by: nirreddy <[email protected]>
  • Loading branch information
BiplabRaut and nirreddy committed Aug 7, 2023
1 parent de33814 commit ac2ce69
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 36 deletions.
36 changes: 2 additions & 34 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -421,41 +421,9 @@ if (BUILD_DOC)
find_package(Doxygen 1.9.6)
set(W_DIR "${CMAKE_CURRENT_SOURCE_DIR}/docs")
if(NOT (DOXYGEN_FOUND))
if (WIN32)
set(DOXYGEN "${CMAKE_CURRENT_SOURCE_DIR}/build/doxygen-1.9.6/doxygen.exe")
if(NOT (EXISTS ${DOXYGEN}))
message(STATUS "so downloading doxygen executables")
file(DOWNLOAD https://github.com/doxygen/doxygen/releases/download/Release_1_9_6/doxygen-1.9.6.windows.x64.bin.zip ${CMAKE_CURRENT_SOURCE_DIR}/build/doxygen.zip
SHOW_PROGRESS )
execute_process(COMMAND powershell Expand-Archive ./doxygen.zip ./doxygen-1.9.6 -Force
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/build/)
file(REMOVE ${CMAKE_CURRENT_SOURCE_DIR}/build/doxygen.zip)
endif()
execute_process(COMMAND "${DOXYGEN}" Doxyfile
WORKING_DIRECTORY ${W_DIR})
elseif (UNIX)
set(greater_than_version 2.28)
execute_process(COMMAND bash -c "ldd --version | head -n 1 | grep -o '....$'"
OUTPUT_VARIABLE ldd_version_output
ERROR_VARIABLE ldd_version_error)
if("${ldd_version_output}" VERSION_GREATER "${greater_than_version}")
set(DOXYGEN "${CMAKE_CURRENT_SOURCE_DIR}/build/doxygen-1.9.6/bin/doxygen")
if(NOT (EXISTS ${DOXYGEN}))
message(STATUS "so downloading doxygen executables")
file(DOWNLOAD https://github.com/doxygen/doxygen/releases/download/Release_1_9_6/doxygen-1.9.6.linux.bin.tar.gz ${CMAKE_CURRENT_SOURCE_DIR}/build/doxygen.gz
SHOW_PROGRESS )
execute_process(COMMAND tar -xf doxygen.gz
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/build)
file(REMOVE ${CMAKE_CURRENT_SOURCE_DIR}/build/doxygen.gz)
endif()
execute_process(COMMAND "${DOXYGEN}" Doxyfile
WORKING_DIRECTORY ${W_DIR})
else()
message(STATUS "Please install doxygen and try again.")
endif()
endif()
message(STATUS "Doxygen not found please install doxygen and try again.")
else()
execute_process(COMMAND doxygen Doxyfile
execute_process(COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
WORKING_DIRECTORY ${W_DIR}
COMMAND_ECHO STDOUT)
endif()
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ Generating Documentation
------------------------
- To generate documentation, specify the `-DBUILD_DOC=ON` option while building.
- Documents will be generated in HTML format in the folder __docs/html__ . Open the index.html file in any browser to view the documentation.
- CMake will use the existing Doxygen if available. Else, it will download the required Doxygen binaries according to the respective operating system you are using to build the documentation.
- CMake will use the existing Doxygen if available. Else, it will prompt the user to install doxygen and try again.


CONTACTS
Expand Down
2 changes: 1 addition & 1 deletion docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,4 +234,4 @@ Generating Documentation
------------------------
- To generate documentation, specify the `-DBUILD_DOC=ON` option while building.
- Documents will be generated in HTML format in the folder __docs/html__ . Open the index.html file in any browser to view the documentation.
- CMake will use the existing Doxygen if available. Else, it will download the required Doxygen binaries according to the respective operating system you are using to build the documentation.
- CMake will use the existing Doxygen if available. Else, it will prompt the user to install doxygen and try again.

0 comments on commit ac2ce69

Please sign in to comment.