docs: conform to consistency

Signed-off-by: msclock <msclock@qq.com>
serious-scaffold · Mar 6, 2024 · fbdff6e · fbdff6e
1 parent dd1d3fd
commit fbdff6e
Show file tree

Hide file tree

Showing 16 changed files with 30 additions and 54 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ A development-focused Cpp project template.
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 [![SS Cpp](https://img.shields.io/badge/Serious%20Scaffold-c++-blue)](https://github.com/serious-scaffold/ss-cpp)
 
-## Features
+## 🛠️ Features
 
 - Project setup and template update with [copier](https://github.com/copier-org/copier/).
 - Customizable container development environment(vscode dev container).

diff --git a/cmake/ConfigureDocs.cmake b/cmake/ConfigureDocs.cmake
@@ -14,7 +14,7 @@ if(DOXYGEN_FOUND)
   set(DOXYGEN_REFERENCES_LINK_SOURCE YES)
   set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
 
-  set(doxygen_docs ${CMAKE_PROJECT_NAME}_doxygen)
+  set(doxygen_docs ${CMAKE_PROJECT_NAME}-doxygen)
   # cmake-format: off
   doxygen_add_docs(
     ${doxygen_docs}

diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "Serious Scaffold Cpp"
-copyright = "2022-2023 Serious Scaffold"
+copyright = "2022-2024 Serious Scaffold"
 author = "msclock"
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/development.md b/docs/development.md
diff --git a/docs/cmake_workflow.md → docs/development/cmake_workflow.md b/docs/cmake_workflow.md → docs/development/cmake_workflow.md
diff --git a/docs/development/index.md b/docs/development/index.md
@@ -0,0 +1,7 @@
+# Development
+
+```{toctree}
+:maxdepth: 1
+
+cmake_workflow
+```
diff --git a/docs/index.md b/docs/index.md
@@ -1,9 +1,5 @@
 # Welcome to Serious Scaffold Cpp's documentation
 
-```{toctree}
-:hidden:
-```
-
 <!-- Extract content from start line 1 of README.md -->
 
 ```{include} ../README.md
@@ -19,16 +15,17 @@
 :glob:
 
 Overview <self>
-cmake_workflow
+development/index
+contributing
 ```
 
 ```{toctree}
 :maxdepth: 1
 :titlesonly:
 :caption: References
 
-api
 changelog
+api
 ```
 
 ## 🔖 Indices and tables

diff --git a/template/.vscode/settings.json b/template/.vscode/settings.json
@@ -1,5 +1,6 @@
 {
   "cmake.useCMakePresets": "always",
+  "cmake.options.statusBarVisibility": "visible",
   "files.exclude": {
     "**/.clangd/**": true
   },
@@ -97,5 +98,5 @@
     "memory_resource": "cpp",
     "numbers": "cpp",
     "semaphore": "cpp"
-  },
+  }
 }
diff --git a/template/CMakePresets.json b/template/CMakePresets.json
@@ -8,7 +8,10 @@
       "generator": "Ninja",
       "hidden": true,
       "binaryDir": "${sourceDir}/out/build/${presetName}",
-      "installDir": "${sourceDir}/out/install/${presetName}"
+      "installDir": "${sourceDir}/out/install/${presetName}",
+      "cacheVariables": {
+        "CMAKE_VERBOSE_MAKEFILE": "FALSE"
+      }
     },
     {
       "name": "x64",

diff --git a/template/CONTRIBUTING.md b/template/CONTRIBUTING.md
@@ -36,7 +36,7 @@ Commit messages must follow our convention based on the
 [Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message)
 or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
 
-```txt
+```tex
 <type>[(scope)]: Subject
 
 [Body]
@@ -65,7 +65,7 @@ If you write a body, please add trailers at the end
 (for example issues and PR references, or co-authors),
 without relying on GitHub's flavored Markdown:
 
-```txt
+```tex
 Body.
 
 Issue #10: https://github.com/namespace/project/issues/10

diff --git a/template/README.md.jinja b/template/README.md.jinja
@@ -13,7 +13,7 @@
 [![SS Cpp](https://img.shields.io/badge/Serious%20Scaffold-c++-blue)](https://github.com/serious-scaffold/ss-cpp)
 
 [% if repo_name == 'ss-cpp' -%]
-## Features
+## 🛠️ Features
 
 - Project setup and template update with [copier](https://github.com/copier-org/copier/).
 - Customizable container development environment(vscode dev container).

diff --git a/template/[% if docs_type == 'sphinx' %]docs[% endif %]/cmake_workflow.md b/template/[% if docs_type == 'sphinx' %]docs[% endif %]/cmake_workflow.md
diff --git a/template/[% if docs_type == 'sphinx' %]docs[% endif %]/index.md.jinja b/template/[% if docs_type == 'sphinx' %]docs[% endif %]/index.md.jinja
@@ -1,9 +1,5 @@
 # Welcome to {{ project_name }}'s documentation
 
-```{toctree}
-:hidden:
-```
-
 <!-- Extract content from start line 1 of README.md -->
 
 ```{include} ../README.md
@@ -19,8 +15,9 @@
 :glob:
 
 Overview <self>
+development/index
 [% if repo_name == 'ss-cpp' -%]
-cmake_workflow
+contributing
 [% endif -%]
 ```
 
@@ -29,8 +26,8 @@ cmake_workflow
 :titlesonly:
 :caption: References
 
-api
 changelog
+api
 ```
 
 ## 🔖 Indices and tables

diff --git a/template/cmake/ConfigureDocs.cmake.jinja b/template/cmake/ConfigureDocs.cmake.jinja
@@ -14,7 +14,7 @@ if(DOXYGEN_FOUND)
   set(DOXYGEN_REFERENCES_LINK_SOURCE YES)
   set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
 
-  set(doxygen_docs ${CMAKE_PROJECT_NAME}_doxygen)
+  set(doxygen_docs ${CMAKE_PROJECT_NAME}-doxygen)
   # cmake-format: off
   doxygen_add_docs(
     ${doxygen_docs}

diff --git a/template/vcpkg.json.jinja b/template/vcpkg.json.jinja
@@ -46,7 +46,7 @@
 [%- endif %]
     {
       "name": "cmake-modules",
-      "version": "1.3.6"
+      "version": "1.3.7"
     },
     {
       "name": "robotology-cmake-ycm",
@@ -57,7 +57,7 @@
     "registries": [
       {
         "kind": "git",
-        "baseline": "8166fd34bde37098afa04b82b0ec7f2a2f467fe3",
+        "baseline": "d21738a465c8d163a84e93c58672a38f69804c36",
         "repository": "https://github.com/msclock/cmake-registry",
         "packages": [
 [%- if use_conan == true %]

diff --git a/vcpkg.json b/vcpkg.json
@@ -20,7 +20,7 @@
     },
     {
       "name": "cmake-modules",
-      "version": "1.3.6"
+      "version": "1.3.7"
     },
     {
       "name": "robotology-cmake-ycm",
@@ -31,7 +31,7 @@
     "registries": [
       {
         "kind": "git",
-        "baseline": "8166fd34bde37098afa04b82b0ec7f2a2f467fe3",
+        "baseline": "d21738a465c8d163a84e93c58672a38f69804c36",
         "repository": "https://github.com/msclock/cmake-registry",
         "packages": [
           "cmake-modules",