mirror of
https://github.com/TheLartians/ModernCppStarter.git
synced 2025-08-30 21:51:12 +02:00
Doxygen support (#43)
* init doxygen * fix format * use readme as main file * don't generate LaTeX * automatically use correct project version and update html settings * minify Doxyfile * add documentation * add workflow to publish documentation * remove mac comment * formatting * fix typo * grammar
This commit is contained in:
parent
fa77b5371f
commit
032e506c12
7 changed files with 144 additions and 13 deletions
36
documentation/CMakeLists.txt
Normal file
36
documentation/CMakeLists.txt
Normal file
|
@ -0,0 +1,36 @@
|
|||
cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
|
||||
|
||||
project(GreeterDocs)
|
||||
|
||||
# ---- Dependencies ----
|
||||
|
||||
include(../cmake/CPM.cmake)
|
||||
|
||||
CPMAddPackage(
|
||||
NAME Greeter
|
||||
SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..
|
||||
)
|
||||
|
||||
CPMAddPackage(
|
||||
NAME StableCoder-cmake-scripts
|
||||
GITHUB_REPOSITORY StableCoder/cmake-scripts
|
||||
GIT_TAG 3d2d5a9fb26f0ce24e3e4eaeeff686ec2ecfb3fb
|
||||
)
|
||||
|
||||
# ---- Doxygen ----
|
||||
|
||||
set(BUILD_DOCUMENTATION ON CACHE INTERNAL "")
|
||||
include(${StableCoder-cmake-scripts_SOURCE_DIR}/doxygen.cmake)
|
||||
|
||||
# set Doxyfile variables
|
||||
set(DOXYGEN_PROJECT_NAME Greeter)
|
||||
set(DOXYGEN_PROJECT_VERSION ${Greeter_VERSION})
|
||||
set(DOXYGEN_PROJECT_ROOT "${CMAKE_CURRENT_LIST_DIR}/..")
|
||||
|
||||
# see https://github.com/StableCoder/cmake-scripts#doxygen-doxygencmake for additional options
|
||||
build_docs(
|
||||
TARGET_NAME GenerateDocs
|
||||
DOXYFILE_PATH ${CMAKE_CURRENT_LIST_DIR}/Doxyfile
|
||||
OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen
|
||||
PROCESS_DOXYFILE ON
|
||||
)
|
Loading…
Add table
Add a link
Reference in a new issue