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.

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

fix: use external searching #4

Merged
merged 1 commit into from
Aug 7, 2024
Merged
Changes from all commits
Commits
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
fix: use external searching
ReenigneArcher committed Aug 7, 2024
commit 0cb84b7b926de1df4369ee742930d045d0d84770
1 change: 1 addition & 0 deletions .doxyconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This is a dummy file, used by CMakeLists.txt
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Ignore JetBrains IDE files
.idea/

# Ignore build directories
build/
cmake-build-*/

# npm
node_modules/
package-lock.json

# ignore doxyconfig files
docs/doxyconfig*

# ignore fake third-party directory
third-party/
22 changes: 18 additions & 4 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
cmake_minimum_required(VERSION 3.18)
project(doxyconfig VERSION 0.0.0
DESCRIPTION "Doxygen configuration for LizardByte projects"
HOMEPAGE_URL "https://app.lizardbyte.dev")

# find doxygen and graphviz
find_package(Doxygen 1.10 REQUIRED dot) # debian and ubuntu left in the dust

@@ -23,12 +28,21 @@ message(STATUS "DOXYGEN_BUILD_DIR_CMAKE: ${DOXYGEN_BUILD_DIR_CMAKE}")
file(MAKE_DIRECTORY "${DOXYGEN_BUILD_DIR_CMAKE}/html")

# copy files to build directory
file(COPY_FILE "${CMAKE_CURRENT_SOURCE_DIR}/header.html" "${SOURCE_DOCS_DIR}/header-doxyconfig.html")
file(COPY_FILE "${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile" "${SOURCE_DOCS_DIR}/Doxyfile-doxyconfig")
file(COPY_FILE "${CMAKE_CURRENT_SOURCE_DIR}/doxyconfig-header.html" "${SOURCE_DOCS_DIR}/doxyconfig-header.html")
file(COPY_FILE "${CMAKE_CURRENT_SOURCE_DIR}/doxyconfig-Doxyfile" "${SOURCE_DOCS_DIR}/doxyconfig-Doxyfile")
file(COPY_FILE "${CMAKE_CURRENT_SOURCE_DIR}/doxyconfig.css" "${SOURCE_DOCS_DIR}/doxyconfig.css")
file(COPY_FILE "${CMAKE_CURRENT_SOURCE_DIR}/doxyconfig-readthedocs-search.js"
"${SOURCE_DOCS_DIR}/doxyconfig-readthedocs-search.js")

# append the "${SOURCE_DOCS_DIR}/Doxyfile to the Doxyfile-doxyconfig
file(READ "${SOURCE_DOCS_DIR}/Doxyfile" DOXYFILE_CONTENTS)
file(APPEND "${SOURCE_DOCS_DIR}/Doxyfile-doxyconfig" "${DOXYFILE_CONTENTS}")
file(APPEND "${SOURCE_DOCS_DIR}/doxyconfig-Doxyfile" "${DOXYFILE_CONTENTS}")

# if this is the doxyconfig project, copy doxygen-awesome-css to third-party
if(EXISTS "${CMAKE_SOURCE_DIR}/.doxyconfig")
file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/doxygen-awesome-css"
DESTINATION "${CMAKE_SOURCE_DIR}/third-party/doxyconfig")
endif()

# sunshine has its own icon and logo
if(NOT ${CMAKE_PROJECT_NAME} STREQUAL "Sunshine")
@@ -86,7 +100,7 @@ add_custom_target(docs ALL
COMMAND ${CMAKE_COMMAND} -E env
READTHEDOCS_OUTPUT=${DOXYGEN_BUILD_DIR_RELATIVE}
READTHEDOCS_VERSION=${DOXYGEN_PROJECT_VERSION}
${DOXYGEN_EXECUTABLE} Doxyfile-doxyconfig
${DOXYGEN_EXECUTABLE} doxyconfig-Doxyfile
VERBATIM
DEPENDS FONT_AWESOME_FILES
)
Loading