chore: move user based documentation into doc/user folder

This commit is contained in:
sithlord48
2025-06-08 18:54:25 -04:00
committed by Nick Bolton
parent b77d722577
commit 6c5d08ba7f
4 changed files with 28 additions and 20 deletions

View File

@ -1,31 +1,19 @@
# SPDX-FileCopyrightText: 2019 - 2024 Chris Rizzitello <sithlord48@gmail.com>
# SPDX-FileCopyrightText: 2019 - 2025 Chris Rizzitello <sithlord48@gmail.com>
# SPDX-License-Identifier: MIT
find_package(Doxygen QUIET)
option(BUILD_DOCS "Build and install documents" ${DOXYGEN_FOUND})
if (BUILD_DOCS AND DOXYGEN_FOUND)
option(BUILD_USER_DOCS "Build and install user documentation" ${DOXYGEN_FOUND})
if (DOXYGEN_FOUND)
# Generic Doxygen options
set(DOXYGEN_EXTRACT_ALL YES)
set(DOXYGEN_STRIP_FROM_PATH ${CMAKE_SOURCE_DIR})
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE mainpage.md)
set(DOXYGEN_QUIET YES)
set(DOXYGEN_PROJECT_NAME ${CMAKE_PROJECT_PROPER_NAME})
# Files used to make our documents
# User facing documents will not include doxy comments in source code
doxygen_add_docs(user-docs ${CMAKE_SOURCE_DIR}/doc COMMENT "Generating user documentation" ALL)
# HACK Only these will show in your IDE
target_sources(user-docs PRIVATE
mainpage.md
configuration.md
)
install(
DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html"
DESTINATION ${CMAKE_INSTALL_DOCDIR}
COMPONENT deskflow_docs)
if (BUILD_USER_DOCS)
add_subdirectory(user)
endif()
else()
message(STATUS "Doxygen not found, skipping docs build")
endif()

20
doc/user/CMakeLists.txt Normal file
View File

@ -0,0 +1,20 @@
# SPDX-FileCopyrightText: 2025 Chris Rizzitello <sithlord48@gmail.com>
# SPDX-License-Identifier: MIT
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE mainpage.md)
# Files used to make our documents
# User facing documents will not include doxy comments in source code
doxygen_add_docs(user-docs ${CMAKE_CURRENT_SOURCE_DIR} COMMENT "Generating user documentation" ALL)
# HACK Only these will show in your IDE
target_sources(user-docs PRIVATE
mainpage.md
configuration.md
)
install(
DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html"
DESTINATION ${CMAKE_INSTALL_DOCDIR}
COMPONENT deskflow_user_docs
)