Skip to content

fix: general improvements and minor bugs #42

fix: general improvements and minor bugs

fix: general improvements and minor bugs #42

Workflow file for this run

name: Generate and Deploy Documentation
on:
push:
branches:
- develop
permissions:
actions: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
publish-docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Setup .NET SDK
uses: actions/setup-dotnet@v3
with:
dotnet-version: 9.x
- name: Install DocFX
run: dotnet tool install -g docfx
- name: Add DocFX to PATH
run: echo "$HOME/.dotnet/tools" >> $GITHUB_PATH
- name: Create wwwroot directory for WebCore
run: mkdir -p ./src/WebExpress.WebCore/wwwroot
- name: Build WebExpress.WebCore
run: |
dotnet build ./src/WebExpress.WebCore/WebExpress.WebCore.csproj -c Release
- name: Generate documentation
run: |
cd docs
docfx metadata
docfx build
- name: Generate API toc.yaml
run: |
echo "### YamlMime:TableOfContent" > docs/api/toc.yaml
echo "[" >> docs/api/toc.yaml
find docs/_site/api -maxdepth 1 -type f -name '*.html' | sort | while read file; do
name=$(basename "$file" .html)
echo " { \"name\": \"$name\", \"href\": \"$name.html\" }," >> docs/api/toc.yaml
done
sed -i '$ s/},/}/' docs/api/toc.yaml
echo "]" >> docs/api/toc.yaml
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs/_site'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4