Skip to content

add community guidlines to README.md #150

add community guidlines to README.md

add community guidlines to README.md #150

name: docs
on:
push:
branches: ["main"]
pull_request:
branches: ["main"]
jobs:
docs:
name: "Build and deploy docs"
runs-on: ubuntu-latest
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: pip
- name: Install Python dependencies
run: |
python -m pip install -r docs/qmd-requirements.txt
python -m pip install .
- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2
- name: Compile quarto documents (ome_zarr.Image)
uses: quarto-dev/quarto-actions/render@v2
with:
to: md,ipynb # If set, it will be equivalent to `quarto render --to X`
path: docs/getting_started_Image.qmd # runs in current working dir, i.e `quarto render .`
- name: Compile quarto documents (legacy classes)
uses: quarto-dev/quarto-actions/render@v2
with:
to: md,ipynb
path: docs/getting_started_hcs_wrappers.qmd
- name: Clean up docs
run: |
rm -rf docs/20200812-CardiomyocyteDifferentiation14-Cycle1.zarr
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
REQUIREMENTS: docs/doc-requirements.txt