deploy_mkdocs.yml

name: Publish docs via GitHub Pages

on:
  push:
    branches:
      - main
    paths:
      # Only rebuild website when docs or python files have changed
      - 'README.md'
      - 'CHANGES.md'
      - 'CONTRIBUTING.md'
      - 'docs/**'
      - 'rio_tiler/**.py'

jobs:
  build:
    name: Deploy docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout main
        uses: actions/checkout@v2

      - name: Set up Python 3.8
        uses: actions/setup-python@v2
        with:
          python-version: 3.8

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install numpy
          python -m pip install -e .["docs"]
          python -m pip install git+https://github.com/timothycrosley/pdocs

      - name: update API docs
        run: |
          pdocs as_markdown \
            --output_dir docs/src/api/ \
            --exclude_source \
            --overwrite \
            rio_tiler.colormap \
            rio_tiler.constants \
            rio_tiler.errors \
            rio_tiler.expression \
            rio_tiler.models \
            rio_tiler.io.base \
            rio_tiler.io.rasterio \
            rio_tiler.io.stac \
            rio_tiler.io.xarray \
            rio_tiler.mosaic.methods.base \
            rio_tiler.mosaic.methods.defaults \
            rio_tiler.mosaic.reader \
            rio_tiler.profiles \
            rio_tiler.reader \
            rio_tiler.tasks \
            rio_tiler.utils

      - name: Deploy docs
        run: mkdocs gh-deploy -f docs/mkdocs.yml --force