Added documentation workflow #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | |
| on: | |
| push: | |
| branches: [master, main] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup .NET | |
| uses: actions/setup-dotnet@v4 | |
| with: | |
| dotnet-version: '8.0.x' | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| cache: pip | |
| cache-dependency-path: requirements-docs.txt | |
| - name: Install DocFX | |
| run: dotnet tool install -g docfx | |
| - name: Build API reference | |
| run: | | |
| cd Documentation | |
| dotnet build Mathx.Docs.csproj | |
| docfx metadata docfx.json | |
| docfx build docfx.json | |
| - name: Stage API into docs tree | |
| run: | | |
| rm -rf docs/api | |
| mkdir -p docs/api | |
| cp -r Documentation/api/_site/* docs/api/ | |
| cp docs/api-stub/index.html docs/api/index.html | |
| - name: Install MkDocs | |
| run: pip install -r requirements-docs.txt | |
| - name: Build site | |
| run: mkdocs build | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |