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

documentation/CMakeLists.txt

@@ -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
+)

documentation/Doxyfile

@@ -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