This repository has been archived by the owner on Jun 6, 2024. It is now read-only.
docs: typo fix #11
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: website | |
| # build the documentation whenever there are new commits on main | |
| on: | |
| push: | |
| branches: | |
| - main | |
| # Alternative: only build for tags. | |
| # tags: | |
| # - '*' | |
| # security: restrict permissions for CI jobs. | |
| permissions: | |
| contents: read | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| #---------------------------------------------- | |
| # check-out repo and set-up python | |
| #---------------------------------------------- | |
| - name: Check out repository | |
| uses: actions/checkout@v3 | |
| - name: Set up python | |
| id: setup-python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.10' | |
| - name: check python version | |
| run: python --version | |
| #---------------------------------------------- | |
| # install & configure poetry | |
| #---------------------------------------------- | |
| - name: Install Poetry | |
| uses: snok/install-poetry@v1 | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| installer-parallel: true | |
| - name: check poetry version | |
| run: poetry --version | |
| #---------------------------------------------- | |
| # load cached venv if cache exists | |
| #---------------------------------------------- | |
| - name: Load cached venv | |
| id: cached-poetry-dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: .venv | |
| key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }} | |
| - name: report cache used | |
| run: echo 'Cache LOADED' | |
| #---------------------------------------------- | |
| # install dependencies if cache does not exist | |
| #---------------------------------------------- | |
| - name: Install dependencies | |
| if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
| run: | | |
| poetry install --no-interaction --no-root | |
| echo 'poetry installed from scratch' | |
| #---------------------------------------------- | |
| # install your root project, if required | |
| #---------------------------------------------- | |
| - name: Install project | |
| run: poetry install --no-interaction | |
| - name: where are we | |
| run: pwd | |
| #---------------------------------------------- | |
| # create fresh docs | |
| #---------------------------------------------- | |
| - name: activate .venv | |
| run: source .venv/bin/activate | |
| - name: pdoc | |
| run: poetry run pdoc src/* --output-directory=dev_docs/ | |
| - uses: actions/upload-pages-artifact@v1 | |
| with: | |
| path: dev_docs/ | |
| # Deploy the artifact to GitHub pages. | |
| # This is a separate job so that only actions/deploy-pages has the necessary permissions. | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v1 |