reorganized repo and updated documentation visuals #9
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: website/requirements-docs.txt | |
| - name: Install Python docs dependencies | |
| run: pip install -r website/requirements-docs.txt | |
| - name: Cache DocFX global tool | |
| uses: actions/cache@v4 | |
| id: docfx-tool-cache | |
| with: | |
| path: ~/.dotnet/tools | |
| key: docfx-2.78.5-${{ runner.os }} | |
| restore-keys: | | |
| docfx-2.78.5-${{ runner.os }} | |
| - name: Install DocFX | |
| if: steps.docfx-tool-cache.outputs.cache-hit != 'true' | |
| run: dotnet tool install -g docfx --version 2.78.5 | |
| - name: Build API reference | |
| run: | | |
| cd website/Documentation~ | |
| dotnet build Mathx.Docs.csproj | |
| docfx metadata docfx.json | |
| python tools/organize_mathx_api.py | |
| docfx build docfx.json | |
| python tools/patch_mathx_hub.py | |
| - name: Stage API into docs tree | |
| run: | | |
| rm -rf website/docs~/api | |
| mkdir -p website/docs~/api | |
| cp -r website/Documentation~/api/_site/* website/docs~/api/ | |
| cp website/docs~/api-stub/index.html website/docs~/api/index.html | |
| - name: Build site | |
| working-directory: website | |
| run: mkdocs build | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: website/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 |