readthedocs

.github/workflows/codeql.yml

@@ -29,16 +29,16 @@ jobs:
           submodules: recursive
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: ${{ matrix.language }}
           config-file: ./.github/codeql.yml
           queries: +security-and-quality
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
+        uses: github/codeql-action/autobuild@v3
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3
         with:
           category: "/language:${{ matrix.language }}"

.readthedocs.yaml

@@ -35,3 +35,7 @@ build:
 python:
   install:
     - requirements: doc/requirements.txt
+
+submodules:
+  include: all
+  recursive: true

doc/Doxyfile

@@ -54,7 +54,7 @@ PROJECT_NUMBER         = 0.5.0
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          =
+PROJECT_BRIEF          = parse and emit YAML, and do it fast
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -668,7 +668,7 @@ SHOW_INCLUDE_FILES     = YES
 # which file to include in order to use the member.
 # The default value is: NO.
 
-SHOW_GROUPED_MEMB_INC  = NO
+SHOW_GROUPED_MEMB_INC  = YES
 
 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
 # files with double quotes in the documentation rather than with sharp brackets.

doc/Makefile

@@ -24,6 +24,9 @@ help:
 	cp -favr doxygen/html "$(BUILDDIR)/html"
 
 doxy:
+	# ensure submodules are checked out
+	if [ ! -d ext/c4core/cmake/c4Project.cmake ] ; then echo "ERROR: submodules not present" ; fi
+	if [ ! -d ext/c4core/src/c4/charconv.hpp ] ; then echo "ERROR: submodules not present" ; fi
 	doxygen Doxyfile
 
 clean:

doc/main.md

@@ -64,7 +64,7 @@ doc_charconv for further details. For example:
 <table>
 <caption id="xtoa-i64">xtoa,int64_t</caption>
 <tr><th>g++12, linux <th>Visual Studio 2019
-<tr><td> \image html linux-x86_64-gxx12.1-Release/c4core-bm-charconv-xtoa-mega_bytes_per_second-i64.png <td> \image html windows-x86_64-vs2019-Release/c4core-bm-charconv-xtoa-mega_bytes_per_second-i64.png
+<tr><td> \image html linux-x86_64-gxx12.1-Release-c4core-bm-charconv-xtoa-mega_bytes_per_second-i64.png <td> \image html windows-x86_64-vs2019-Release-c4core-bm-charconv-xtoa-mega_bytes_per_second-i64.png
 </table>