Skip to content

Create CONTRIBUTING.md #24

Create CONTRIBUTING.md

Create CONTRIBUTING.md #24

Workflow file for this run

name: Docs build
# build the documentation whenever there are new commits on main
on:
push:
branches:
- main
# security: restrict permissions for CI jobs.
permissions:
contents: read
jobs:
# Build the documentation and upload the static HTML files as an artifact.
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.10'
- run: pip install -e .[dev]
- run: pdoc -o docs/ src/cellmap_models
- uses: actions/upload-pages-artifact@v3
with:
path: docs/
# Deploy the artifact to GitHub pages.
# NOTE: You must enable GitHub pages in Settings with the Source as Github Actions
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@v4