mirror of
https://github.com/TheLartians/ModernCppStarter.git
synced 2025-12-17 20:14:36 +03: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:
25
documentation/Doxyfile
Normal file
25
documentation/Doxyfile
Normal file
@@ -0,0 +1,25 @@
|
||||
# Configuration for Doxygen for use with CMake
|
||||
# Only options that deviate from the default are included
|
||||
# To create a new Doxyfile containing all available options, call `doxygen -g`
|
||||
|
||||
# Get Project name and version from CMake
|
||||
PROJECT_NAME = @DOXYGEN_PROJECT_NAME@
|
||||
PROJECT_NUMBER = @DOXYGEN_PROJECT_VERSION@
|
||||
|
||||
# Add sources
|
||||
INPUT = @DOXYGEN_PROJECT_ROOT@/README.md @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@/source
|
||||
EXTRACT_ALL = YES
|
||||
RECURSIVE = YES
|
||||
|
||||
# We don't want local paths in the documentation
|
||||
FULL_PATH_NAMES = NO
|
||||
|
||||
# Use the README as a main page
|
||||
USE_MDFILE_AS_MAINPAGE = @DOXYGEN_PROJECT_ROOT@/README.md
|
||||
|
||||
# Create nicer looking HTML
|
||||
HTML_DYNAMIC_SECTIONS = YES
|
||||
GENERATE_TREEVIEW = YES
|
||||
|
||||
# We don't need LaTeX generation
|
||||
GENERATE_LATEX = NO
|
||||
Reference in New Issue
Block a user