Enhance Doxygen and automatically deployment

.github/workflows/test.yml → .github/workflows/check.yml

@@ -1,11 +1,14 @@
+name: Check
+
 on:
     push:
         branches:
             - master
     pull_request:
 
 jobs:
-    test:
+    build:
+        name: Test
         runs-on: ubuntu-latest
         steps:
             - name: Checkout repository

.github/workflows/gh-pages.yml

@@ -0,0 +1,42 @@
+name: GitHub Pages
+
+on:
+    push:
+        branches:
+            - master
+    workflow_dispatch:
+
+permissions:
+    contents: write
+
+concurrency:
+    group: gh-pages-deploy
+    cancel-in-progress: true
+
+jobs:
+    build-and-deploy:
+        name: Build and Deploy
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+              with:
+                  submodules: false
+
+            - name: Initialize doxygen-awesome-css submodule
+              run: git submodule update --init --depth 1 doxygen-awesome-css
+
+            - name: Install Doxygen and Graphviz
+              run: |
+                  sudo apt-get update
+                  sudo apt-get install doxygen graphviz
+
+            - name: Run Doxygen
+              run: doxygen
+
+            - name: Deploy to gh-pages
+              uses: peaceiris/actions-gh-pages@v4
+              with:
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  publish_dir: ./build/html
+                  publish_branch: gh-pages

.gitignore

@@ -1,14 +1,11 @@
-/*
-**/.cache
-**/.clangd
-**/compile_flags.txt
+code/
+build/
 
-!include/
-!leetcode/
-!test/
-!.github/
-!.clang-format
-!ruff.toml
-!README.md
-!CMakeLists.txt
-!ac-library
+.venv/
+.ruff_cache/
+.zed/
+.fastolympiccoding/
+**/.cache/
+
+compile_commands.json
+.clangd

Doxyfile

@@ -26,7 +26,7 @@ PROJECT_BRIEF          = "API reference and notes for competitive-programming"
 PROJECT_NUMBER         =
 
 # Where to put the generated documentation (relative to where doxygen is run)
-OUTPUT_DIRECTORY       = docs/doxygen
+OUTPUT_DIRECTORY       = build
 
 # Create subdirectories for output files (useful for large projects)
 CREATE_SUBDIRS         = YES
@@ -83,14 +83,18 @@ PREDEFINED             =
 EXPAND_AS_DEFINED      =
 
 # Source browsing
-SOURCE_BROWSER         = YES
-INLINE_SOURCES         = YES
-VERBATIM_HEADERS       = YES
+# Disable embedding source code and inline sources in the generated documentation
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = NO
+# Do not include verbatim copies of headers in the output
+VERBATIM_HEADERS       = NO
+# Keep stripping special comment blocks from source fragments (not used when sources are disabled)
 STRIP_CODE_COMMENTS    = YES
 REFERENCED_BY_RELATION = YES
 REFERENCES_RELATION    = YES
 REFERENCES_LINK_SOURCE = YES
-SOURCE_TOOLTIPS        = YES
+# Disable source tooltips since source browsing is disabled
+SOURCE_TOOLTIPS        = NO
 
 # HTML output configuration
 GENERATE_HTML          = YES

include/.gitignore

@@ -0,0 +1,2 @@
+.clangd
+compile_flags.txt