doc: improve API overview page #8
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: Publish Documentation | |
| on: | |
| push: | |
| paths: | |
| - 'mkdocs.yml' | |
| - 'docs/**' | |
| permissions: | |
| contents: write | |
| jobs: | |
| documentation-job: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: SCM Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v6 | |
| - name: Build Documentation | |
| run: | | |
| uv run just build-docs | |
| touch site/.nojekyll | |
| - name: Deploy Documentation | |
| uses: JamesIves/github-pages-deploy-action@v4.6.8 | |
| with: | |
| branch: gh-pages | |
| folder: site | |
| git-config-name: Github Action | |
| git-config-email: romix.lab@gmail.com |