fix: wire notifications into gateway + README polish #23
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: API Docs | |
| # Generate the Python API reference with pdoc and publish it to GitHub | |
| # Pages on every push to main. PR builds run pdoc as a smoke test (to | |
| # catch broken docstrings) but skip the deploy step. | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - 'runtime/**/*.py' | |
| - 'gateway/**/*.py' | |
| - 'hivemind/**/*.py' | |
| - '.github/workflows/docs.yml' | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - 'runtime/**/*.py' | |
| - 'gateway/**/*.py' | |
| - 'hivemind/**/*.py' | |
| - '.github/workflows/docs.yml' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| name: Build pdoc site | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| cache: pip | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| pip install pdoc | |
| - name: Build API docs | |
| run: | | |
| mkdir -p site | |
| pdoc \ | |
| --output-directory site \ | |
| --docformat google \ | |
| --logo "https://raw.githubusercontent.com/${{ github.repository }}/main/docs/logo.png" \ | |
| --footer-text "0pnMatrx — built by Neo" \ | |
| runtime gateway hivemind | |
| - name: Upload Pages artifact | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v4 |