Robin Mueller
c2bf09d506
This PR introduces the generation of documentation based on this excellent blog post: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/ It combines the tools Sphinx, Doxygen and Breathe to generate good looking HTML documentation conveniently which can be hosted easily. The helper scripts were unified and there is now one helper.py script which can be used to create, build and open both tests and documentation. "./helper.py -h" can be used to get the different options. This PR also contains some smaller fixes which were necessary for the docs to build
13 lines
383 B
CMake
13 lines
383 B
CMake
# Look for an executable called sphinx-build
|
|
find_program(SPHINX_EXECUTABLE
|
|
NAMES sphinx-build
|
|
DOC "Path to sphinx-build executable")
|
|
|
|
include(FindPackageHandleStandardArgs)
|
|
|
|
# Handle standard arguments to find_package like REQUIRED and QUIET
|
|
find_package_handle_standard_args(
|
|
Sphinx
|
|
"Failed to find sphinx-build executable"
|
|
SPHINX_EXECUTABLE
|
|
) |