add reference doc generation

Author: zone117x

.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [master, develop]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.0.x
+
+      - name: Install DocFX
+        run: dotnet tool install -g docfx
+
+      - name: Build Documentation
+        run: |
+          cp README.md docs/index.md
+          docfx docs/docfx.json
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -330,3 +330,8 @@ ASALocalRun/
 .mfractor/
 coverage
 CoverageReport
+
+# DocFX
+docs/_site/
+docs/api/
+docs/index.md

README.md

@@ -56,6 +56,8 @@ See the [examples project](Secp256k1.Net.Examples/) for more complete working ex
 
 ## API Reference
 
+**[Full API Documentation](https://zone117x.github.io/Secp256k1.Net/api/Secp256k1Net.Secp256k1.html)**
+
 The `Secp256k1` class exposes static functions that are idiomatic C#, using a thread-safe internal context:
 
 #### Key Generation & Validation

docs/build.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+set -e
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
+
+# Check if docfx is installed
+if ! command -v docfx &> /dev/null; then
+    echo "DocFX not found. Installing..."
+    dotnet tool install -g docfx
+fi
+
+cd "$SCRIPT_DIR"
+
+# Copy README.md as index.md
+cp "$ROOT_DIR/README.md" "$SCRIPT_DIR/index.md"
+
+# Build the documentation
+docfx docfx.json "$@"
+
+echo ""
+echo "Documentation built successfully in docs/_site/"
+echo "To preview, run: ./docs/build.sh --serve"

docs/docfx.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": ["Secp256k1.Net/Secp256k1.Net.csproj"],
+          "src": ".."
+        }
+      ],
+      "dest": "api",
+      "includePrivateMembers": false,
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "properties": {
+        "TargetFramework": "net8.0"
+      }
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": ["api/**.yml", "api/index.md"]
+      },
+      {
+        "files": ["toc.yml", "index.md"]
+      }
+    ],
+    "resource": [
+      {
+        "files": ["images/**"]
+      }
+    ],
+    "output": "_site",
+    "template": ["default", "modern"],
+    "globalMetadata": {
+      "_appTitle": "Secp256k1.Net",
+      "_appName": "Secp256k1.Net",
+      "_appFooter": "Secp256k1.Net - Cross-platform .NET wrapper for bitcoin-core/secp256k1",
+      "_enableSearch": true,
+      "_enableNewTab": true
+    },
+    "fileMetadata": {},
+    "postProcessors": [],
+    "keepFileLink": false,
+    "disableGitFeatures": false
+  }
+}

docs/toc.yml

@@ -0,0 +1,6 @@
+- name: Home
+  href: index.md
+- name: API Reference
+  href: api/
+- name: GitHub
+  href: https://github.com/zone117x/Secp256k1.Net