chore: rename docs related cmake targets to use dash naming convention

Signed-off-by: msclock <msclock@qq.com>
serious-scaffold · Dec 1, 2023 · 95ace5e · 95ace5e
1 parent c5192b6
commit 95ace5e
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 24 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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()