Skip to content

fix documentation

fix documentation #23

Workflow file for this run

name: GitHub Pages
on:
push:
branches:
- main
- website
pull_request:
branches:
- main
- website
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout website branch
uses: actions/checkout@v4
with:
ref: website
- name: Checkout main branch
uses: actions/checkout@v4
with:
ref: main
path: ./code/
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
- name: Install Python requirements
run: pip install -r requirements.txt
- name: Generate documentation
run: python3 ./docs/documentation/produce_doc.py ./code/src/cytools/
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
- name: Install dependencies
run: npm ci
- name: Build website
run: npm run build
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./build
deploy:
if: github.event_name == 'push'
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4