Skip to content

Add release steps to readme: #11

Add release steps to readme:

Add release steps to readme: #11

Workflow file for this run

name: Publish docs via GitHub Pages
on:
push:
branches:
- main
paths:
# Only rebuild website when docs have changed
- 'README.md'
- 'docs/**'
- '.github/workflows/deploy_mkdocs.yml'
jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v2
- name: Set up Python 3.11
uses: actions/setup-python@v2
with:
python-version: 3.11.9
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install .[docs]
- name: update API docs
run: |
pdocs as_markdown \
--output_dir docs/src/api \
--exclude_source \
--overwrite \
stacchip.chipper \
stacchip.indexer
- name: Deploy docs
run: mkdocs gh-deploy --force -f docs/mkdocs.yml