Merge pull request #23 from metagenlab/dev #40
This file contains 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 | |
| paths: | |
| - ".github/workflows/build-docs.yml" | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - "!Dockerfile" | |
| - "!.github/workflows/docker-publish.yml" | |
| - "!.github/workflows/unit-tests.yml" | |
| - "!tests/**" | |
| - "!assembly_finder/**" | |
| - "!setup.py" | |
| - "!README.md" | |
| # Cancel if a newer run is started | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| rich_codex: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out the repo | |
| uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: 3.x | |
| - uses: actions/cache@v2 | |
| with: | |
| key: ${{ github.ref }} | |
| path: .cache | |
| - name: Install requirements for docs | |
| run: pip install mkdocs-material . | |
| - name: Generate terminal images with rich-codex | |
| uses: ewels/rich-codex@v1 | |
| with: | |
| commit_changes: "true" | |
| clean_img_paths: docs/imgages/*.svg | |
| skip_git_checks: "true" | |
| terminal_width: 85 | |
| - name: Build and deploy docs | |
| run: mkdocs gh-deploy --force |