Merge branch 'release/v0.2.0'

.github/workflows/publish_docs.yml

@@ -1,42 +1,47 @@
 name: PublishDocs
 
+# make the documentation up to date with the develop branch
 on:
   push:
     branches:
-      - main
+      - develop
+    paths:
+      - docs/mkdocs/**
   workflow_dispatch:
 
+# no cancellation during uploads to avoid broken publications
+concurrency:
+  group: documentation
+  cancel-in-progress: false
+
 permissions:
   contents: read
   pages: write
   id-token: write
 
 jobs:
   build:
+    if: github.repository == 'fktn-k/fkYAML'
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
 
-      - name: Install graphviz and doxygen
-        run: |
-          sudo apt update
-          sudo apt install -y --no-install-recommends graphviz doxygen
-
-      - name: Configure CMake
-        run: make doxygen
+      - name: Build documentation
+        run: make build -C docs/mkdocs
 
       - name: Setup Pages
         uses: actions/configure-pages@v3
 
       - name: Upload API documents
         uses: actions/upload-pages-artifact@v2
         with:
-          path: ${{github.workspace}}/build_doxygen/doxygen/html
+          path: ${{github.workspace}}/docs/mkdocs/site
 
   deploy:
+    if: github.repository == 'fktn-k/fkYAML'
     needs: build
     environment:
       name: github-pages

.gitignore

@@ -1,3 +1,7 @@
 build*
 .vscode/
-.vs/
+.vs/
+
+# documentation
+/docs/mkdocs/site/
+/docs/mkdocs/venv/

.reuse/templates/fkYAML.commented.jinja2

@@ -1,15 +1,13 @@
-/**
- *  _______   __ __   __  _____   __  __  __
- * |   __| |_/  |  \_/  |/  _  \ /  \/  \|  |     fkYAML: A C++ header-only YAML library
- * |   __|  _  < \_   _/|  ___  |    _   |  |___  version 0.1.3
- * |__|  |_| \__|  |_|  |_|   |_|___||___|______| https://github.com/fktn-k/fkYAML
- *
+///  _______   __ __   __  _____   __  __  __
+/// |   __| |_/  |  \_/  |/  _  \ /  \/  \|  |     fkYAML: A C++ header-only YAML library
+/// |   __|  _  < \_   _/|  ___  |    _   |  |___  version 0.2.0
+/// |__|  |_| \__|  |_|  |_|   |_|___||___|______| https://github.com/fktn-k/fkYAML
+///
 {% for copyright_line in copyright_lines %}
- * {{ copyright_line }}
+/// {{ copyright_line }}
 {% endfor %}
 {% for expression in spdx_expressions %}
- * SPDX-License-Identifier: {{ expression }}
+/// SPDX-License-Identifier: {{ expression }}
 {% endfor %}
- *
- * @file
- */
+///
+/// @file

.reuse/templates/fkYAML_support.jinja2

@@ -1,6 +1,6 @@
  _______   __ __   __  _____   __  __  __
 |   __| |_/  |  \_/  |/  _  \ /  \/  \|  |     fkYAML: A C++ header-only YAML library (supporting code)
-|   __|  _  < \_   _/|  ___  |    _   |  |___  version 0.1.3
+|   __|  _  < \_   _/|  ___  |    _   |  |___  version 0.2.0
 |__|  |_| \__|  |_|  |_|   |_|___||___|______| https://github.com/fktn-k/fkYAML
 
 {% for copyright_line in copyright_lines %}

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [v0.2.0](https://github.com/fktn-k/fkYAML/releases/tag/v0.2.0) (2023-11-06)
+
+[Full Changelog](https://github.com/fktn-k/fkYAML/compare/v0.1.3...v0.2.0)
+
+- \#187 support compatible strings as an argument in basic\_node ctors [\#188](https://github.com/fktn-k/fkYAML/pull/188) ([fktn-k](https://github.com/fktn-k))
+- \#180 Generalize getter APIs for node value references [\#184](https://github.com/fktn-k/fkYAML/pull/184) ([fktn-k](https://github.com/fktn-k))
+- \#180 clean up public apis [\#183](https://github.com/fktn-k/fkYAML/pull/183) ([fktn-k](https://github.com/fktn-k))
+- \#177 Add test for input adapters only [\#178](https://github.com/fktn-k/fkYAML/pull/178) ([fktn-k](https://github.com/fktn-k))
+- \#167 Use std::map as the default mapping node type [\#174](https://github.com/fktn-k/fkYAML/pull/174) ([fktn-k](https://github.com/fktn-k))
+- \#105 Support std::initializer\_list in basic\_node constructors [\#173](https://github.com/fktn-k/fkYAML/pull/173) ([fktn-k](https://github.com/fktn-k))
+
+- \#185 fixed missing calls for fclose\(\) in input adapter tests [\#186](https://github.com/fktn-k/fkYAML/pull/186) ([fktn-k](https://github.com/fktn-k))
+- \#175 support detecting indentation in deserialization [\#176](https://github.com/fktn-k/fkYAML/pull/176) ([fktn-k](https://github.com/fktn-k))
+
+- Updated header template and target file for version up script [\#197](https://github.com/fktn-k/fkYAML/pull/197) ([fktn-k](https://github.com/fktn-k))
+- \#179 Added integration with Google Analytics 4 [\#196](https://github.com/fktn-k/fkYAML/pull/196) ([fktn-k](https://github.com/fktn-k))
+- \#179 Updated pages in the Home section in the documentation [\#194](https://github.com/fktn-k/fkYAML/pull/194) ([fktn-k](https://github.com/fktn-k))
+- \#179 Migrate the gh-page content with MkDocs [\#193](https://github.com/fktn-k/fkYAML/pull/193) ([fktn-k](https://github.com/fktn-k))
+- \#179 Created tutorial pages [\#192](https://github.com/fktn-k/fkYAML/pull/192) ([fktn-k](https://github.com/fktn-k))
+- \#179 Migrate API docs with MkDocs [\#189](https://github.com/fktn-k/fkYAML/pull/189) ([fktn-k](https://github.com/fktn-k))
+- \#179 introduce mkdocs for documentation [\#182](https://github.com/fktn-k/fkYAML/pull/182) ([fktn-k](https://github.com/fktn-k))
+
 ## [v0.1.3](https://github.com/fktn-k/fkYAML/releases/tag/v0.1.3) (2023-10-21)
 
 [Full Changelog](https://github.com/fktn-k/fkYAML/compare/v0.1.2...v0.1.3)

CMakeLists.txt

@@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 3.8)
 
 project(
   fkYAML
-  VERSION 0.1.3
+  VERSION 0.2.0
   LANGUAGES CXX)
 
 #############################################################
@@ -114,15 +114,6 @@ if(FK_YAML_BUILD_TEST OR FK_YAML_BUILD_ALL_TEST)
   add_subdirectory(test)
 endif()
 
-##################################
-#   Generate API documentation   #
-##################################
-
-if(FK_YAML_RUN_DOXYGEN)
-  set(FK_YAML_DOXYGEN_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/doxygen")
-  add_subdirectory(docs)
-endif()
-
 #######################
 #   Install package   #
 #######################

Makefile

@@ -15,8 +15,8 @@ CMAKE_SCRIPTS = $(shell find . -type f \( -name 'CMakeLists.txt' -o -name '*.cma
 
 # target version definition
 TARGET_MAJOR_VERSION := 0
-TARGET_MINOR_VERSION := 1
-TARGET_PATCH_VERSION := 3
+TARGET_MINOR_VERSION := 2
+TARGET_PATCH_VERSION := 0
 TARGET_VERSION_FULL := $(TARGET_MAJOR_VERSION).$(TARGET_MINOR_VERSION).$(TARGET_PATCH_VERSION)
 VERSION_MACRO_FILE := include/fkYAML/detail/macros/version_macros.hpp
 
@@ -32,7 +32,6 @@ all:
 	@echo "clang-sanitizers - check whether no runtime issue is detected while running the unit test app."
 	@echo "clang-tidy - check whether source files detect no issues during static code analysis."
 	@echo "cmake-format - check whether CMake scripts are well formatted."
-	@echo "doxygen - generate the API documentation for the project with Doxygen."
 	@echo "html-coverage - generate HTML coverage report."
 	@echo "iwyu - check whether source files are each self-contained."
 	@echo "lcov-coverage - generate coverage data with lcov."
@@ -82,15 +81,6 @@ valgrind:
 cmake-format:
 	cmake-format $(CMAKE_SCRIPTS) -i -c .cmake-format.yaml
 
-#####################
-#   Documentation   #
-#####################
-
-# pre-requisites: doxygen, graphviz
-doxygen:
-	cmake -B build_doxygen -S . -DFK_YAML_RUN_DOXYGEN=ON
-	cmake --build build_doxygen --target doxygen -j $(JOBS)
-
 ###############
 #   Version   #
 ###############
@@ -111,7 +101,7 @@ update-project-version:
 	$(shell sed -i 's/VERSION [0-9]\+\.[0-9]\+\.[0-9]\+/VERSION $(TARGET_VERSION_FULL)/' CMakeLists.txt)
 
 update-git-tag-ref:
-	$(shell sed -i 's/GIT_TAG \+v[0-9]\+\.[0-9]\+\.[0-9]\+/GIT_TAG v$(TARGET_VERSION_FULL)/' README.md)
+	$(shell sed -i 's/GIT_TAG \+v[0-9]\+\.[0-9]\+\.[0-9]\+/GIT_TAG v$(TARGET_VERSION_FULL)/' docs/mkdocs/docs/tutorials/cmake_integration.md)
 	$(shell sed -i 's/GIT_TAG \+v[0-9]\+\.[0-9]\+\.[0-9]\+/GIT_TAG v$(TARGET_VERSION_FULL)/' test/cmake_fetch_content_test/project/CMakeLists.txt)
 
 # pre-requisites: pipx, reuse
@@ -164,6 +154,5 @@ clean:
 		build_clang_sanitizers \
 		build_clang_tidy \
 		build_coverage \
-		build_doxygen \
 		build_iwyu \
 		build_valgrind