diff options
| author | J08nY | 2024-06-17 13:40:50 +0200 |
|---|---|---|
| committer | J08nY | 2024-06-17 13:40:50 +0200 |
| commit | 5ed639b78b180979ba79ab64af7933deaf4f8a5e (patch) | |
| tree | 60a46397b7f9adc683418c3744f094120d9aff27 | |
| parent | abc889d4fd8f5c104f3367a788e3c766138b25fd (diff) | |
| download | pyecsca-5ed639b78b180979ba79ab64af7933deaf4f8a5e.tar.gz pyecsca-5ed639b78b180979ba79ab64af7933deaf4f8a5e.tar.zst pyecsca-5ed639b78b180979ba79ab64af7933deaf4f8a5e.zip | |
| -rw-r--r-- | .github/workflows/docs.yml | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..33c8da4 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,63 @@ +name: Docs + +on: + push: + branches: + - master + +env: + LLVM_CONFIG: /usr/bin/llvm-config-10 + PS_PACKAGES: libps4000 libps5000 libps6000 + GMP_PACKAGES: libgmp-dev libmpfr-dev libmpc-dev + OTHER_PACKAGES: swig gcc libpcsclite-dev llvm-10 libllvm10 llvm-10-dev libpari-dev pari-gp pari-seadata + +jobs: + docs: + runs-on: ubuntu-20.04 + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + # Do the build and deploy + steps: + - uses: actions/checkout@v4 + with: + submodules: true + - uses: actions/cache@v4 + with: + path: ~/.cache/pip + key: pip-${{ runner.os }}-3.11-${{ hashFiles('pyproject.toml') }} + restore-keys: | + pip-${{ runner.os }}- + - name: Setup Python 3.11 + uses: actions/setup-python@v5 + with: + python-version: "3.11" + - name: Add picoscope repository + run: | + curl "https://labs.picotech.com/debian/dists/picoscope/Release.gpg.key" | sudo apt-key add + sudo echo "deb https://labs.picotech.com/debian/ picoscope main" | sudo tee /etc/apt/sources.list.d/picoscope.list + sudo apt-get update + - name: Install system dependencies + run: | + sudo apt-get install -y $PS_PACKAGES $OTHER_PACKAGES $GMP_PACKAGES + - name: Install picoscope bindings + run: | + python -m pip install -U pip setuptools wheel + git clone https://github.com/colinoflynn/pico-python && cd pico-python && pip install . && cd .. + git clone https://github.com/picotech/picosdk-python-wrappers && cd picosdk-python-wrappers && pip install . && cd .. + - name: Install dependencies + run: | + pip install -e ".[picoscope_sdk, picoscope_alt, chipwhisperer, smartcard, gmp, leia, test, dev, doc]" + - name: Build docs + run: | + make docs + - uses: actions/upload-pages-artifact + with: + path: docs/_build/ + - id: deployment + uses: actions/deploy-pages@v4 |
