add separate make doxygen target to build reference docs without de…

…pending on Jekyll
anapupa · Mar 2, 2019 · f76ee34 · f76ee34
1 parent 3e70ede
commit f76ee34
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -11,6 +11,12 @@ endif()
 # prepare doxygen configuration file
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
+# add doxygen as custom target
+add_custom_target(doxygen ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+  # POST_BUILD
+  COMMAND ${CMAKE_COMMAND} -E copy_directory "${CMAKE_CURRENT_SOURCE_DIR}/fonts" "${CMAKE_CURRENT_BINARY_DIR}/html/fonts"
+)
+
 # add docs as custom target
 add_custom_target(docs ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
   # POST_BUILD

diff --git a/docs/installation.md b/docs/installation.md
@@ -93,9 +93,11 @@ located in the current working directory.
 
 In order to build the full HTML manual and reference documentation call
 
-    $ make docs
+    $ make doxygen
 
-The resulting HTML documentation can be found in the `docs/` sub-directory.
+The resulting HTML documentation can be found in the `docs/html/`
+sub-directory. Note: this requires [Doxygen](http://www.doxygen.nl/) to be
+installed.
 
 ## Installation