adds overview #139
Workflow file for this run
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: Build documentation | |
| on: | |
| push: | |
| paths: | |
| - 'docs/**' | |
| pull_request: | |
| paths: | |
| - 'docs/**' | |
| workflow_dispatch: | |
| paths: | |
| - 'docs/**' | |
| jobs: | |
| docs: | |
| name: Build html docs only | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: build docs | |
| uses: Tiryoh/actions-mkdocs@v0 | |
| with: | |
| mkdocs_version: 'latest' | |
| requirements: 'docs/requirements-github.txt' | |
| configfile: 'mkdocs-github.yml' | |
| - name: show contents of compiled docs | |
| run: | | |
| ls -R site |