Repository navigation
docs: add contribution guidlines for extras (#654) #187
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: Algorithm Docs Generation | |
| permissions: | |
| contents: read | |
| pull-requests: read | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| concurrency: | |
| group: ci-${{ github.repository }}-docs-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| generate-docs: | |
| runs-on: ubuntu-22.04 | |
| strategy: | |
| matrix: | |
| python-version: ["3.11"] | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v6 | |
| - uses: ./.github/actions/setup-uv-project | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Run generation script | |
| run: python docs/utils/gen_docs.py | |
| - name: Verify generated file exists | |
| run: | | |
| if [ ! -f compression.rst ]; then | |
| echo "Error: Generated file 'compression.rst' not found!" | |
| exit 1 | |
| fi | |
| - name: Upload generated file | |
| uses: actions/upload-artifact@v6 | |
| with: | |
| name: compression-rst | |
| path: compression.rst |