diff options
| author | Aina Niemetz <aina.niemetz@gmail.com> | 2021-04-13 10:19:12 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-13 17:19:12 +0000 |
| commit | cdb5c6e7e03e4717f21c5726f02763962c23a7b2 (patch) | |
| tree | 91ef3495eeedc9b80086d6b6201ba52590952e88 | |
| parent | ee7442e1c79e94be8e3e23777679980b8c505d1c (diff) | |
API docs: Add custom target to build for GH pages. (#6335)
| -rw-r--r-- | INSTALL.md | 4 | ||||
| -rw-r--r-- | docs/CMakeLists.txt | 28 |
2 files changed, 28 insertions, 4 deletions
diff --git a/INSTALL.md b/INSTALL.md index 1e4ce607e..14290afca 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -217,6 +217,10 @@ The API documentation can then be found at `<build_dir>/docs/sphinx/index.html`. To only build the documentation, change to the build directory and call `make docs`. +To build the documentation for GitHub pages, change to the build directory +and call `make docs-gh`. The content of directory `<build_dir>/docs/sphinx-gh` +can then be copied over to GitHub pages. + ## Building the Examples diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 4b799615d..b65a10e47 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -45,9 +45,29 @@ set(SPHINX_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/sphinx) add_custom_target(docs ALL DEPENDS docs-doxygen COMMAND - ${SPHINX_EXECUTABLE} -b html - # Tell Breathe where to find the Doxygen output - -Dbreathe_projects.cvc5=${DOXYGEN_OUTPUT_DIR}/xml - ${SPHINX_INPUT_DIR} ${SPHINX_OUTPUT_DIR} + ${SPHINX_EXECUTABLE} -b html + # Tell Breathe where to find the Doxygen output + -Dbreathe_projects.cvc5=${DOXYGEN_OUTPUT_DIR}/xml + ${SPHINX_INPUT_DIR} ${SPHINX_OUTPUT_DIR} WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} COMMENT "Generating Sphinx Api docs") + +set(SPHINX_GH_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/sphinx-gh) +add_custom_target(docs-gh ALL + DEPENDS docs + COMMAND ${CMAKE_COMMAND} -E remove_directory + ${SPHINX_GH_OUTPUT_DIR} + COMMAND ${CMAKE_COMMAND} -E copy_directory + ${SPHINX_OUTPUT_DIR} ${SPHINX_GH_OUTPUT_DIR} + COMMAND ${CMAKE_COMMAND} -E remove_directory + ${SPHINX_GH_OUTPUT_DIR}/_sources + COMMAND ${CMAKE_COMMAND} -E remove + ${SPHINX_GH_OUTPUT_DIR}/objects.inv + COMMAND ${CMAKE_COMMAND} -E rename + ${SPHINX_GH_OUTPUT_DIR}/_static + ${SPHINX_GH_OUTPUT_DIR}/static + COMMAND find ${SPHINX_GH_OUTPUT_DIR} -type f | + xargs sed -i'orig' 's/_static/static/' + COMMAND find ${SPHINX_GH_OUTPUT_DIR} -name '*orig' -delete + COMMENT "Generating GitHub Api docs") + |