Skip to content

GitHub Pages

GitHub Pages #796

Workflow file for this run

name: GitHub Pages
on:
push:
branches: [main, ]
schedule:
- cron: '0 2 * * 6'
pull_request:
branches:
- '**'
permissions:
contents: write
jobs:
deploy-pages:
concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
runs-on: macos-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v4 # If you're using actions/checkout@v4 you must set persist-credentials to false in most cases for the deployment to work correctly.
with:
persist-credentials: false
- uses: actions/setup-python@v4
with:
python-version: '3.13'
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
run: |
set -x
export PCAPKIT_SPHINX=1
export PCAPKIT_DEVMODE=1
python -m pip install -U pip setuptools wheel
python -m pip install -r docs/requirements.txt
python -m pip install -e .[all]
rm -rf docs/build
make -C docs html
# disable Jekyll
touch docs/build/html/.nojekyll
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@v4
if: ${{ github.event_name != 'pull_request' }}
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages # The branch the action should deploy to.
folder: docs/build/html # The folder the action should deploy.
clean: true # Automatically remove deleted files from the deploy branch