docs: Generate doxygen programmer’s manual with mkdocs through mkdoxy

.github/workflows/documentation.yml

@@ -23,7 +23,7 @@ jobs:
     env:
       PYTHONWARNINGS: always
       # renovate: datasource=python-version depName=python
-      PYTHON_VERSION: "3.13"
+      PYTHON_VERSION: "3.12"
 
     steps:
       - name: Checkout core
@@ -35,7 +35,7 @@ jobs:
       - name: Get dependencies
         run: |
           sudo apt-get update -y
-          sudo apt-get install -y wget git gawk findutils
+          sudo apt-get install -y wget git gawk findutils doxygen graphviz
           xargs -a <(awk '! /^ *(#|$)/' "grass/.github/workflows/apt.txt") -r -- \
               sudo apt-get install -y --no-install-recommends --no-install-suggests
 
@@ -45,6 +45,14 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: pip
 
+      - name: Set up Homebrew
+        if: false
+        id: set-up-homebrew
+        uses: Homebrew/actions/setup-homebrew@main
+      - name: Install newer doxygen with homebrew
+        if: false
+        run: brew install doxygen
+
       - name: Set version variables
         run: |
           cd grass
@@ -190,3 +198,17 @@ jobs:
           if-no-files-found: error
           path: ${{ env.MKDOCS_DIR }}/site
           retention-days: 3
+
+      - name: Generate doxygen docs
+        run: |
+          cd grass
+          make htmldocs
+      - name: Make the doxygen results available
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: doxygen-site
+          if-no-files-found: error
+          path: |
+            grass/html
+            grass/latex
+          retention-days: 3

include/Make/Doxyfile_arch_html.in

@@ -675,6 +675,7 @@ RECURSIVE              = YES
 # run.
 
 EXCLUDE                = bin.@ARCH@ \
+                         build \
                          db \
                          debian \
                          demolocation \
@@ -700,6 +701,7 @@ EXCLUDE                = bin.@ARCH@ \
                          man \
                          misc \
                          mswindows \
+                         out \
                          ps \
                          raster \
                          raster3d \

include/Make/Doxyfile_arch_latex.in

@@ -675,6 +675,7 @@ RECURSIVE              = YES
 # run.
 
 EXCLUDE                = bin.@ARCH@ \
+                         build \
                          db \
                          debian \
                          demolocation \
@@ -700,6 +701,7 @@ EXCLUDE                = bin.@ARCH@ \
                          man \
                          misc \
                          mswindows \
+                         out \
                          ps \
                          raster \
                          raster3d \

man/mkdocs/mkdocs.yml

@@ -94,6 +94,71 @@ plugins:
       cards_layout_options:
         background_color: rgb(76, 176, 91)
         background_image: null
+  - mkdoxy:
+      projects:
+        programming8: # name of project must be alphanumeric + numbers (without spaces)
+          debug: True
+          #src-dirs: ../../.. # path to source code (support multiple paths separated by space) => INPUT
+          src-dirs: /home/runner/work/grass/grass/grass
+          # src-dirs: /home/vscode/grass/lib
+          # full-doc: False
+          full-doc: True # if you want to generate full documentation
+          doxy-cfg: # standard doxygen configuration (key: value)
+            FILE_PATTERNS: "*.dox *.c *.h *.cpp *.hpp" # specify file patterns to filter out
+            RECURSIVE: True # recursive search in source directories
+            WARN_LOGFILE: "doxygen.log"
+            EXCLUDE_PATTERNS: >-
+              */test/*
+              */tests/*
+              */unit_test/*
+              */unit_tests/*
+              */unit_test*
+              */unit_tests*
+              */test_suite/*
+              */testsuite/*
+              */test_*
+              */test.*
+              */*local_proto.h
+            EXCLUDE: >-
+              bin.*
+              build
+              db
+              debian
+              demolocation
+              display
+              dist.*
+              doc
+              general
+              gui
+              imagery
+              include/defs
+              lib/btree/test
+              lib/db/dbmi_base/test
+              lib/db/sqlp/test
+              lib/gmath/test
+              lib/gpde/test
+              lib/linkm/test
+              lib/raster3d/test
+              lib/vector/dglib/examples
+              lib/vector/rtree/docs
+              python
+              locale
+              macosx
+              man
+              misc
+              mswindows
+              out
+              ps
+              raster
+              raster3d
+              rpm
+              scripts
+              sites
+              temporal
+              testsuite
+              utils
+              vector
+              visualization
 
 # Markdown extensions
 markdown_extensions:
@@ -177,7 +242,10 @@ nav:
       - PostScript tools: postscript.md
       - Miscellaneous tools: miscellaneous.md
 
-  - Development: development_intro.md
+  - Development:
+      - Development: development_intro.md
+      - C API reference and developer manual: "programming8/links.md"
+      - C API reference and developer manual files: "programming8/files.md"
 
 not_in_nav: |
   r.*

man/mkdocs/requirements.txt

@@ -4,3 +4,4 @@ mkdocs-material==9.6.15
 pymdown-extensions==10.16
 pyyaml-env-tag==1.1
 mkdocs-material[imaging]==9.6.15
+mkdoxy==1.2.7