Skip to content

update doc workflow #119

update doc workflow

update doc workflow #119

Workflow file for this run

name: Publish docs via GitHub Pages
# Only run on new tags
on:
push:
tags:
- '*'
workflow_dispatch:
paths:
- '.github/workflows/deploy_mkdocs.yml'
jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v4
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -e ".[psycopg-binary]"
python -m pip install nbconvert mkdocs mkdocs-material mkdocs-jupyter pygments pdocs mike~=2.0
- name: update API docs
run: |
pdocs as_markdown \
--output_dir docs/src/api \
--exclude_source \
--overwrite \
titiler.pgstac.db \
titiler.pgstac.dependencies \
titiler.pgstac.extensions \
titiler.pgstac.factory \
titiler.pgstac.model \
titiler.pgstac.mosaic \
titiler.pgstac.reader \
titiler.pgstac.settings \
titiler.pgstac.utils
- name: Set module version
id: module
run: |
echo version=$(python -c'import titiler.pgstac; print(titiler.pgstac.__version__)') >> $GITHUB_OUTPUT
- name: Configure Git user
run: |
git config user.name github-actions
git config user.email [email protected]
- name: Fetch gh-pages repository
run: |
git fetch origin gh-pages --depth=1
- name: Deploy documentation and update alias for latest
run: |
mike deploy ${{ steps.module.outputs.version}} latest --push --update-aliases --config-file docs/mkdocs.yml