From a9aacd4d48c3a5887267366c2ef643e953975792 Mon Sep 17 00:00:00 2001 From: Michal Cmarada Date: Mon, 11 Mar 2019 13:29:57 +0100 Subject: add documentation generator Enables generating of HTML documentation. It depends on sphinx generator. During configuration if sphinx is detected it will generate "docs" target for make. To build the documentation use "make docs", which will build the HTML documentation in build-root/html. Change-Id: Ia627f7d26c954a2341e13a54006955d21d162802 Signed-off-by: Michal Cmarada --- docs/CMakeLists.txt | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/CMakeLists.txt (limited to 'docs/CMakeLists.txt') diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 0000000..a03333e --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,34 @@ +find_package(Sphinx REQUIRED) + +if(SPHINX_FOUND) + if(NOT DEFINED SPHINX_THEME) + set(SPHINX_THEME default) + endif() + + if(NOT DEFINED SPHINX_THEME_DIR) + set(SPHINX_THEME_DIR) + endif() + + # configured documentation tools and intermediate build results + set(BINARY_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/_build") + + # Sphinx cache with pickled ReST documents + set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees") + + # HTML output directory + set(SPHINX_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/../build-root/html") + + configure_file( + "${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in" + "${BINARY_BUILD_DIR}/conf.py" + @ONLY) + + add_custom_target(docs + ${SPHINX_EXECUTABLE} + -q -b html + -c "${BINARY_BUILD_DIR}" + -d "${SPHINX_CACHE_DIR}" + "${CMAKE_CURRENT_SOURCE_DIR}" + "${SPHINX_HTML_DIR}" + COMMENT "Building HTML documentation with Sphinx") +endif() -- cgit 1.2.3-korg