From 95ace5e96566823302b5303a532b8b10c29b83db Mon Sep 17 00:00:00 2001 From: msclock Date: Sun, 19 Nov 2023 17:55:58 +0800 Subject: [PATCH] chore: rename docs related cmake targets to use dash naming convention Signed-off-by: msclock --- cmake/ConfigureCoverage.cmake | 6 +++--- cmake/ConfigureDocs.cmake | 14 +++++++------- docs/api.md | 2 +- docs/conf.py | 2 +- docs/index.md | 2 +- .../api.md.jinja | 2 +- template/cmake/ConfigureCoverage.cmake | 6 +++--- template/cmake/ConfigureDocs.cmake.jinja | 14 +++++++------- 8 files changed, 24 insertions(+), 24 deletions(-) diff --git a/cmake/ConfigureCoverage.cmake b/cmake/ConfigureCoverage.cmake index 0ce01f28..88e748ca 100644 --- a/cmake/ConfigureCoverage.cmake +++ b/cmake/ConfigureCoverage.cmake @@ -6,9 +6,9 @@ add_code_coverage_all_targets( ${VCPKG_INSTALLED_DIR}/* ${CMAKE_BINARY_DIR}/* /usr/* - HTML_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}_docs/coverage) + HTML_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}-docs/coverage) # cmake-format: on -if(TARGET ${CMAKE_PROJECT_NAME}_docs) - add_dependencies(ccov-all ${CMAKE_PROJECT_NAME}_docs) +if(TARGET ${CMAKE_PROJECT_NAME}-docs) + add_dependencies(ccov-all ${CMAKE_PROJECT_NAME}-docs) endif() diff --git a/cmake/ConfigureDocs.cmake b/cmake/ConfigureDocs.cmake index 44fa2cc2..623548c3 100644 --- a/cmake/ConfigureDocs.cmake +++ b/cmake/ConfigureDocs.cmake @@ -1,5 +1,5 @@ # Build the target by issuing: cmake --build . --target -# ${CMAKE_PROJECT_NAME}_docs +# ${CMAKE_PROJECT_NAME}-docs include(cmake-modules/configure/ConfigDoxygen) configdoxygen() @@ -12,23 +12,23 @@ if(DOXYGEN_FOUND) # cmake-format: off doxygen_add_docs( - ${CMAKE_PROJECT_NAME}_doxygen + ${CMAKE_PROJECT_NAME}-doxygen "${CMAKE_BINARY_DIR}/git/include" - "${CMAKE_BINARY_DIR}/compile/include" + "${CMAKE_BINARY_DIR}/src/compile/include" "${PROJECT_SOURCE_DIR}/src/compile/include" "${PROJECT_SOURCE_DIR}/src/executable/include" "${PROJECT_SOURCE_DIR}/src/header_only/include" COMMENT "gen doxygen style docs automatically") # cmake-format: on - if(TARGET ${CMAKE_PROJECT_NAME}_doxygen) + if(TARGET ${CMAKE_PROJECT_NAME}-doxygen) list(APPEND CMAKE_MODULE_PATH "${cmake-modules_MODULE_PATH}/configure") find_package(Sphinx REQUIRED breathe) sphinx_add_docs( - ${CMAKE_PROJECT_NAME}_docs + ${CMAKE_PROJECT_NAME}-docs BREATHE_PROJECTS - ${CMAKE_PROJECT_NAME}_doxygen + ${CMAKE_PROJECT_NAME}-doxygen BUILDER html BREATH_DEBUG @@ -38,6 +38,6 @@ if(DOXYGEN_FOUND) SOURCE_DIRECTORY docs OUTPUT_DIRECTORY - ${CMAKE_PROJECT_NAME}_docs) + ${CMAKE_PROJECT_NAME}-docs) endif() endif() diff --git a/docs/api.md b/docs/api.md index 9c2450d9..fa3f1800 100644 --- a/docs/api.md +++ b/docs/api.md @@ -3,5 +3,5 @@ This documentation was generated by Doxygen + Breathe ```{doxygenindex} -:project: ss-cpp_doxygen +:project: ss-cpp-doxygen ``` diff --git a/docs/conf.py b/docs/conf.py index ea3d91d7..414969bf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,7 +17,7 @@ # -- Project information ----------------------------------------------------- -project = "SS Cpp" +project = "Serious Scaffold Cpp" copyright = "2022-2023 Serious Scaffold" author = "msclock" diff --git a/docs/index.md b/docs/index.md index 413921ba..42dadd0c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# Welcome to SS Cpp's documentation +# Welcome to Serious Scaffold Cpp's documentation ```{toctree} :hidden: diff --git a/template/[% if docs_type == 'sphinx' %]docs[% endif %]/api.md.jinja b/template/[% if docs_type == 'sphinx' %]docs[% endif %]/api.md.jinja index df57546a..c8fdeca8 100644 --- a/template/[% if docs_type == 'sphinx' %]docs[% endif %]/api.md.jinja +++ b/template/[% if docs_type == 'sphinx' %]docs[% endif %]/api.md.jinja @@ -3,5 +3,5 @@ This documentation was generated by Doxygen + Breathe ```{doxygenindex} -:project: {{ repo_name }}_doxygen +:project: {{ repo_name }}-doxygen ``` diff --git a/template/cmake/ConfigureCoverage.cmake b/template/cmake/ConfigureCoverage.cmake index 0ce01f28..88e748ca 100644 --- a/template/cmake/ConfigureCoverage.cmake +++ b/template/cmake/ConfigureCoverage.cmake @@ -6,9 +6,9 @@ add_code_coverage_all_targets( ${VCPKG_INSTALLED_DIR}/* ${CMAKE_BINARY_DIR}/* /usr/* - HTML_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}_docs/coverage) + HTML_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}-docs/coverage) # cmake-format: on -if(TARGET ${CMAKE_PROJECT_NAME}_docs) - add_dependencies(ccov-all ${CMAKE_PROJECT_NAME}_docs) +if(TARGET ${CMAKE_PROJECT_NAME}-docs) + add_dependencies(ccov-all ${CMAKE_PROJECT_NAME}-docs) endif() diff --git a/template/cmake/ConfigureDocs.cmake.jinja b/template/cmake/ConfigureDocs.cmake.jinja index 42824b26..5031882f 100644 --- a/template/cmake/ConfigureDocs.cmake.jinja +++ b/template/cmake/ConfigureDocs.cmake.jinja @@ -1,5 +1,5 @@ # Build the target by issuing: cmake --build . --target -# ${CMAKE_PROJECT_NAME}_docs +# ${CMAKE_PROJECT_NAME}-docs include(cmake-modules/configure/ConfigDoxygen) configdoxygen() @@ -12,10 +12,10 @@ if(DOXYGEN_FOUND) # cmake-format: off doxygen_add_docs( - ${CMAKE_PROJECT_NAME}_doxygen + ${CMAKE_PROJECT_NAME}-doxygen "${CMAKE_BINARY_DIR}/git/include" [%- if add_compile_target == true %] - "${CMAKE_BINARY_DIR}/compile/include" + "${CMAKE_BINARY_DIR}/src/compile/include" "${PROJECT_SOURCE_DIR}/src/compile/include" [%- endif %] [%- if add_executable_target == true %] @@ -27,14 +27,14 @@ if(DOXYGEN_FOUND) COMMENT "gen doxygen style docs automatically") # cmake-format: on - if(TARGET ${CMAKE_PROJECT_NAME}_doxygen) + if(TARGET ${CMAKE_PROJECT_NAME}-doxygen) list(APPEND CMAKE_MODULE_PATH "${cmake-modules_MODULE_PATH}/configure") find_package(Sphinx REQUIRED breathe) sphinx_add_docs( - ${CMAKE_PROJECT_NAME}_docs + ${CMAKE_PROJECT_NAME}-docs BREATHE_PROJECTS - ${CMAKE_PROJECT_NAME}_doxygen + ${CMAKE_PROJECT_NAME}-doxygen BUILDER html BREATH_DEBUG @@ -44,6 +44,6 @@ if(DOXYGEN_FOUND) SOURCE_DIRECTORY docs OUTPUT_DIRECTORY - ${CMAKE_PROJECT_NAME}_docs) + ${CMAKE_PROJECT_NAME}-docs) endif() endif()