re-generate with doxygen

Author: ilg-ul

.github/workflows/publish-github-pages.yml

@@ -83,6 +83,21 @@ jobs:
       - name: Install dependencies
         run: (cd website; npm ci)
 
+      - name: Install Doxygen
+        # https://www.doxygen.nl/download.html
+        env:
+          DOXYGEN_VERSION: "1.13.2"
+        run: |
+          curl https://www.doxygen.nl/files/doxygen-$DOXYGEN_VERSION.linux.bin.tar.gz --output doxygen-$DOXYGEN_VERSION.linux.bin.tar.gz
+          tar xf doxygen-$DOXYGEN_VERSION.linux.bin.tar.gz
+          ls -l doxygen-$DOXYGEN_VERSION
+          mkdir -pv website/doxygen/.local/bin
+          ln -sv $(pwd)/doxygen-$DOXYGEN_VERSION/bin/doxygen website/doxygen/.local/bin/doxygen
+          ls -lLA website website/doxygen
+
+      - name: Build the Doxygen site
+        run: (cd website/doxygen; .local/bin/doxygen config.doxyfile)
+
       - name: Build the Docusaurus site
         run: (cd website; npm run build)
 

package.json

@@ -60,7 +60,8 @@
   },
   "topConfig": {
     "descriptiveName": "µOS++ Intrusive Lists",
-    "permalinkName": "utils-lists"
+    "permalinkName": "utils-lists",
+    "useDoxygen": "true"
   },
   "engines": {
     "node": " >=18.0.0"

website/docs/_common/_branches-details.mdx

@@ -11,7 +11,7 @@ The project uses multiple branches:
 - `master`, not actively used
 - `xpack`, with the latest stable version (default)
 - `xpack-development`, with the current development version
-- `master`, with the current content of the website; pushes to this branch automatically trigger publishes the main website
+- `website`, with the current content of the website; pushes to this branch automatically trigger publishes the main website
 - `development`, with the current content of the preview website; pushes to this branch automatically trigger publishes the preview website
 
 All development is done in the `xpack-development` branch, and contributions via

website/docs/_common/_publish-website.mdx

@@ -6,14 +6,14 @@
 ### Publish the website
 
 The website deployment is performed automatically when pushing to the
-`master` branch, by a dedicated workflow in
+`website` branch, by a dedicated workflow in
 [GitHub Actions](https://github.com/micro-os-plus/utils-lists-xpack/actions/workflows/publish-github-pages.yml).
 
 - open https://micro-os-plus.github.io/utils-lists-xpack/docs/maintainer/#publish-the-website in a separate window
 - stop the local web server
-- switch to the `master` branch
-- **merge** the `xpack-development` branch into the `master` branch
-- **push** the `master` branch to GitHub
+- switch to the `website` branch
+- **merge** the `xpack-development` branch into the `website` branch
+- **push** the `website` branch to GitHub
   :::info
   At this moment an automated GitHub Action will generate and publish the website.
   :::
@@ -25,7 +25,7 @@ in https://micro-os-plus.github.io/utils-lists-xpack/blog/
 - remember the post URL, since it must be used to update the release page
 and the X/Twitter announcement
 
-The `master` branch may be subsequently updated, as long as the
+The `website` branch may be subsequently updated, as long as the
 version in `package.json` is not changed.
 
 Check the result at https://micro-os-plus.github.io/utils-lists-xpack/.

website/docs/_common/_regenerate-doxygen.mdx

@@ -1,2 +1,16 @@
 
 {/* ------------------------------------------------------------------------ */}
+
+### Re-generate the Doxygen pages
+
+Run the **doxygen** npm script:
+
+```sh
+npm run doxygen -C website
+```
+
+For the moment the doxygen program must be installed on the host,
+it is not available as an xpm dependency.
+
+With the current configuration, the static html pages are generated
+in the `website/static/reference` folder.

website/docs/maintainer/_common/_check-git.mdx

@@ -10,7 +10,7 @@ In the `micro-os-plus/utils-lists-xpack` Git repo:
 - switch to the `xpack-development` branch
 - pull new changes
 - if necessary, **merge** the `xpack` branch
-- if necessary, **merge** the `master` branch
+- if necessary, **merge** the `website` branch
 
 :::caution
 

website/docusaurus.config.ts

@@ -69,7 +69,7 @@ const config: Config = {
         sidebarPath: './sidebars.ts',
         // Please change this to your repo.
         // Remove this to remove the "edit this page" links.
-        editUrl: 'https://github.com/micro-os-plus/utils-lists-xpack/edit/master/website/',
+        editUrl: 'https://github.com/micro-os-plus/utils-lists-xpack/edit/website/website/',
         // showLastUpdateAuthor: true,
         showLastUpdateTime: true,
       },
@@ -86,7 +86,7 @@ const config: Config = {
         },
         // Please change this to your repo.
         // Remove this to remove the "edit this page" links.
-        editUrl: 'https://github.com/micro-os-plus/utils-lists-xpack/edit/master/website/',
+        editUrl: 'https://github.com/micro-os-plus/utils-lists-xpack/edit/website/website/',
         // Useful options to enforce blogging best practices
         onInlineTags: 'warn',
         onInlineAuthors: 'warn',