docs.yml

name: docs

on:
  push:
    branches: [main, dev]
  workflow_dispatch:

jobs:

  docs:
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -l {0}

    steps:
      - name: check out repository
        uses: actions/checkout@v3

      - name: set up Conda/Mamba
        uses: conda-incubator/setup-miniconda@v2
        with:
          python-version: "3.10"
          mamba-version: "*"
          auto-update-conda: true
          activate-environment: zarp-cli
          environment-file: install/environment.dev.root.yml
          auto-activate-base: false

      - name: display environment info
        run: |
          conda info -a
          conda list

      - name: cache build artifacts
        uses: actions/cache@v3
        with:
          key: ${{ github.ref }}
          path: .cache

      - name: install doc requirements
        run: pip install -r docs/requirements.txt

      - name: create markdown documents
        run: |
          lazydocs \
              --no-watermark \
              --output-path="./docs/docstring" \
              --overview-file="README.md" \
              --src-base-url="https://github.com/zavolanlab/zarp-cli/blob/dev/" \
              --validate \
              zarp

      - name: publish docs
        run: mkdocs gh-deploy --force --clean --verbose