fix ruff to <0.3.0, and re-format files again #9
Workflow file for this run
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: documentation | |
| on: | |
| # Triggers the workflow on push but only for the main branch | |
| push: | |
| # branches: [ main ] | |
| paths: | |
| - specsanalyzer/**/* | |
| - specsscan/**/* | |
| - tutorial/** | |
| - .github/workflows/documentation.yml | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Check out repo and set up Python | |
| - name: Check out the repository | |
| uses: actions/checkout@v4 | |
| with: | |
| lfs: true | |
| # see https://stackoverflow.com/questions/57612428/cloning-private-github-repository-within-organisation-in-actions and https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key | |
| - name: checkout test data | |
| run: | | |
| eval `ssh-agent -s` | |
| ssh-add - <<< '${{ secrets.TEST_DATA_ACCESS_KEY }}' | |
| git submodule sync --recursive | |
| git submodule update --init --recursive | |
| # Use cached python and dependencies, install poetry | |
| - name: "Setup Python, Poetry and Dependencies" | |
| uses: packetcoders/action-setup-cache-python-poetry@main | |
| with: | |
| python-version: 3.8 | |
| poetry-version: 1.2.2 | |
| - name: Install notebook dependencies | |
| run: poetry install -E notebook --with docs | |
| - name: Install pandoc | |
| run: | | |
| sudo wget https://github.com/jgm/pandoc/releases/download/3.1.8/pandoc-3.1.8-1-amd64.deb | |
| sudo dpkg -i pandoc-3.1.8-1-amd64.deb | |
| # rm because hextof_workflow notebook can not run outside maxwell | |
| - name: copy tutorial files to docs | |
| run: | | |
| cp -r $GITHUB_WORKSPACE/tutorial $GITHUB_WORKSPACE/docs/ | |
| cp -r $GITHUB_WORKSPACE/specsscan/config $GITHUB_WORKSPACE/docs/specsscan/ | |
| mkdir $GITHUB_WORKSPACE/docs/tests | |
| cp -r $GITHUB_WORKSPACE/tests/data $GITHUB_WORKSPACE/docs/tests/ | |
| # To be included later | |
| # - name: Cache docs build | |
| # id: cache-docs | |
| # uses: actions/cache@v3 | |
| # with: | |
| # path: $GITHUB_WORKSPACE/_build | |
| # key: ${{ runner.os }}-docs | |
| - name: build Sphinx docs | |
| run: poetry run sphinx-build -b html $GITHUB_WORKSPACE/docs $GITHUB_WORKSPACE/_build | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: '_build' | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |