Merge pull request #20 from educredentials/feature/cors-headers #81
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: | |
| - main | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write # To push a branch | |
| pages: write # To push to a GitHub Pages site | |
| id-token: write # To update the deployment status | |
| steps: | |
| - uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install latest mdbook and mdbook-mermaid | |
| run: | | |
| mdbook_tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name') | |
| mdbook_url="https://github.com/rust-lang/mdbook/releases/download/${mdbook_tag}/mdbook-${mdbook_tag}-x86_64-unknown-linux-gnu.tar.gz" | |
| mermaid_tag=$(curl 'https://api.github.com/repos/badboy/mdbook-mermaid/releases/latest' | jq -r '.tag_name') | |
| mermaid_url="https://github.com/badboy/mdbook-mermaid/releases/download/${mermaid_tag}/mdbook-mermaid-${mermaid_tag}-x86_64-unknown-linux-musl.tar.gz" | |
| mkdir mdbook | |
| curl -sSL $mdbook_url | tar -xz --directory=./mdbook | |
| curl -sSL $mermaid_url | tar -xz --directory=./mdbook | |
| echo `pwd`/mdbook >> $GITHUB_PATH | |
| - name: Build Book | |
| run: | | |
| cd docs | |
| mdbook build | |
| - name: Generate OpenAPI Docs | |
| run: | | |
| mkdir -p docs/book/openapi | |
| cp docs/api/openapi.yaml docs/book/openapi/openapi.yaml | |
| cp docs/api/index.html docs/book/openapi/index.html | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v3 | |
| - name: Install dependencies and generate Python Docs | |
| run: | | |
| uv sync | |
| uv run pdoc -o docs/book/pydoc src/ | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: 'docs/book' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |