[DOCS-#3] Github : Added Workflow to Publish Docs

Author: djoezeke

.github/workflows/docs.yml

@@ -0,0 +1,59 @@
+name: Publish Documentation
+
+# publish the documentation on every merge to main branch
+on:
+  push:
+    branches: [main]
+    paths: [docs/mkdocs/**]
+
+  pull_request:
+    branches: [main]
+    paths: [docs/mkdocs/**]
+
+  workflow_dispatch:
+
+# we don't want to have concurrent jobs, and we don't want to cancel running jobs to avoid broken publications
+concurrency:
+  group: documentation
+  cancel-in-progress: false
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Build & Publish Documentation to GitHub Pages.
+
+    permissions:
+      contents: write
+
+    defaults:
+      run:
+        working-directory: ./docs/mkdocs
+
+    if: github.repository == 'djoezeke/mytoml'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Build distributions & Docs
+        run: |
+          mkdocs build
+
+      - name: Publish documentation 📚 to GitHub Pages
+        run: mkdocs gh-deploy --force
+        env:
+          # This token is automatically provided by GitHub Actions
+          # and has the necessary permissions to push to gh-pages.
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/README.md

@@ -0,0 +1,37 @@
+# Documentation
+
+Note on documentation: The source files contain links to the online documentation at https://djoezeke.github.io/mytoml.
+
+> [!NOTE]
+> This URL contains the most recent [documentation](https://djoezeke.github.io/mytoml).
+
+## Generate documentation
+
+> [!TIP]
+> If you want to see the documentation for a specific tag or commit hash, you can generate it as follows (here for tag`v1.0.0`):
+>
+> ```
+> git clone https://github.com/djoezeke/mytoml.git
+> cd mytoml
+> git checkout v1.0.0
+> ```
+
+### Mkdocs
+
+Generating documentation with mkdocs:
+
+```bash
+git clone https://github.com/djoezeke/mytoml.git
+cd mytoml
+```
+
+> Open URL <http://127.0.0.1:8000/> in your browser to see the documentation.
+
+### Doxygen
+
+Generating documentation with doxygen:
+
+```bash
+git clone https://github.com/djoezeke/mytoml.git
+cd mytoml
+```

docs/mkdocs/docs/index.md

@@ -0,0 +1 @@
+# Mytoml

docs/mkdocs/mkdocs.yml

@@ -0,0 +1,97 @@
+# Project information
+site_name: Mytoml | TOML for Modern C/C++
+site_url: https://djoezeke.github.io/mytoml
+site_dir: site/mytoml
+site_author: djoezeke
+site_description: Simple and Fast Tom's Obvious Markup Language (TOML) Parser for Modern C/C++.
+strict: true
+
+# Repository
+repo_url: https://github.com/djoezeke/mytoml
+repo_name: djoezeke/mytoml
+edit_uri: edit/main/docs/mkdocs/docs
+
+# Copyright
+copyright: Copyright © 2025 Sackey Ezekiel Etrue
+
+# https://www.mkdocs.org/user-guide/configuration/#validation
+validation:
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
+
+# Configuration
+theme:
+  name: material
+  features:
+    - navigation.instant
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.indexes
+    - navigation.top
+    - content.tabs.link
+    - content.action.edit
+    - content.action.view
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+  icon:
+    repo: fontawesome/brands/github
+  font:
+    text: Roboto
+    code: JetBrains Mono
+
+# Additional configuration
+extra:
+  status:
+    new: Recently added
+    deprecated: Deprecated
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/djoezeke
+  generator: false
+
+# Extensions
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.snippets:
+  - pymdownx.magiclink:
+  - attr_list:
+  - toc:
+      permalink: true
+      anchorlink: true
+      anchorlink_class: "toclink"
+  - md_in_html:
+  - pymdownx.inlinehilite:
+  - pymdownx.superfences:
+  - markdown.extensions.attr_list:
+  - pymdownx.keys:
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.tabbed:
+      alternate_style: true
+
+# Hooks
+
+# Plugins
+plugins:
+  - search
+
+# Page tree
+nav:
+  - Introduction: index.md

docs/mkdocs/requirements.txt

@@ -0,0 +1,4 @@
+mkdocs                  # Documentation framework
+mkdocs-material         # Theme for mkdocs
+mkdocstrings            # Support for docstrings
+mkdocstrings-python     # Python support for mkdocstrings