Major updates, start orientation, start documentation.

This commit is contained in:
2019-08-03 03:37:37 -07:00
parent 2ecc14f46c
commit 0dc47cdbce
15 changed files with 3163 additions and 192 deletions

17
docs/CMakeLists.txt Normal file
View File

@@ -0,0 +1,17 @@
find_package(Doxygen REQUIRED)
# Find all the public headers
get_target_property(WRMATH_PUBLIC_HEADER_DIR libwrmath INTERFACE_INCLUDE_DIRECTORIES)
file(GLOB_RECURSE WRMATH_PUBLIC_HEADERS ${WRMATH_PUBLIC_HEADER_DIR}/*.h)
#This will be the main output of our command
set(DOXYGEN_INDEX_FILE ${CMAKE_CURRENT_SOURCE_DIR}/html/index.html)
add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
DEPENDS ${WRMATH_PUBLIC_HEADERS}
COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
MAIN_DEPENDENCY Doxyfile
COMMENT "Generating docs")
add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE})

2494
docs/Doxyfile Normal file

File diff suppressed because it is too large Load Diff

2
docs/requirements.txt Normal file
View File

@@ -0,0 +1,2 @@
sphinx
breathe