Skip to content

Implemented blackboard documentation page #303

Implemented blackboard documentation page

Implemented blackboard documentation page #303

Workflow file for this run

name: Generate Docfx documentation
on:
push:
branches:
- main
workflow_dispatch:
jobs:
generate-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
# Setup git user config.
- name: Setup user config
run: |
git config --global user.name 'MikeBrixia'
git config --global user.email '[email protected]'
# Clean documentation folder to free space for updated docs.
- name: Clean previously generated documentation
run: |
git fetch origin gh-pages
git checkout gh-pages
git rm -r --ignore-unmatch .
git add --all
git commit -m 'Clean outdated documentation' --allow-empty
git push origin gh-pages
git ls-tree -r --name-only gh-pages
git checkout main
# Install/update dotnet.
- name: Dotnet Setup
uses: actions/setup-dotnet@v3
with:
dotnet-version: 7.x
# Generate documentation.
- run: dotnet tool update -g docfx
- run: docfx Documentation/docfx.json
# Update the documentation.
- name: Update documentation
run: |
git fetch origin gh-pages
git ls-tree -r --name-only main
git add --all
git status
git checkout gh-pages
git status
git commit -m 'Automated documentation update'
git push origin gh-pages
# Move the generated repository to the root.
- name: Move site to repository root
run: |
git fetch origin gh-pages
git mv Documentation/_site/* .
git commit -m 'Automated documentation update - move to repo root'
git push origin gh-pages