fix #34
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: docs | |
| on: | |
| push: | |
| branches: [main, dev, upgrade_ci] | |
| workflow_dispatch: | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| steps: | |
| - name: check out repository | |
| uses: actions/checkout@v4 | |
| - name: set up Miniforge with ZARP-cli environment | |
| uses: conda-incubator/setup-miniconda@v3 | |
| with: | |
| environment-file: install/environment.dev.yml | |
| miniforge-version: latest | |
| conda-remove-defaults: true | |
| channel-priority: strict | |
| auto-update-conda: true | |
| auto-activate-base: false | |
| activate-environment: zarp-cli | |
| - name: display Conda and environment info | |
| run: | | |
| conda info -a | |
| conda list | |
| - name: cache build artifacts | |
| uses: actions/cache@v4 | |
| 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 |