From 20a01e7df044ca68c699c3ac7aa99feb286e073b Mon Sep 17 00:00:00 2001 From: infeeeee Date: Wed, 8 Mar 2023 00:39:11 +0100 Subject: [PATCH] Create website.yml --- .github/workflows/website.yml | 58 +++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 .github/workflows/website.yml diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml new file mode 100644 index 0000000..afd0d95 --- /dev/null +++ b/.github/workflows/website.yml @@ -0,0 +1,58 @@ +name: website + +# build the documentation whenever there are new commits on main +on: + push: + branches: + - main + # Alternative: only build for tags. + # tags: + # - '*' + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + + +# security: restrict permissions for CI jobs. +permissions: + contents: read + +# Allow one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + + +jobs: + # Build the documentation and upload the static HTML files as an artifact. + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: '3.11' + + - run: pip install -e .[doc] + # ADJUST THIS: build your documentation into docs/. + # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. + - run: pdoc -d google -o docs dyn2py + + - uses: actions/upload-pages-artifact@v1 + with: + path: 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