docs: Generate documentation with sphinx #160
This file contains 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: Pull requests | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| - 'jlf/*' | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| with: | |
| buildkitd-flags: --debug | |
| - name: Build container | |
| uses: docker/build-push-action@v5 | |
| with: | |
| context: compose | |
| push: false | |
| load: true | |
| tags: ghcr.io/adfinis/pyaptly/cache:latest | |
| cache-from: type=registry,ref=ghcr.io/adfinis/pyaptly/cache:gha | |
| - name: Run tests | |
| run: | | |
| HYPOTHESIS_PROFILE=ci make test | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| with: | |
| buildkitd-flags: --debug | |
| - name: Build container | |
| uses: docker/build-push-action@v5 | |
| with: | |
| context: compose | |
| push: false | |
| load: true | |
| tags: ghcr.io/adfinis/pyaptly/cache:latest | |
| cache-from: type=registry,ref=ghcr.io/adfinis/pyaptly/cache:gha | |
| - name: Generate the docs | |
| run: | | |
| make docs | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: html-docs | |
| path: docs/_build/html/ |