Added badges to the README, updated usage instructions. #61
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
| on: | |
| push: | |
| branches: | |
| - master | |
| name: Build documentation | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Add Pretty CSS | |
| uses: wei/wget@v1 | |
| with: | |
| args: -O docs/doxygen-awesome.css https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css | |
| - name: Get the tatami tagfile | |
| uses: wei/wget@v1 | |
| with: | |
| args: -O docs/tatami.tag https://tatami-inc.github.io/tatami/tatami.tag | |
| - name: Get the manticore tagfile | |
| uses: wei/wget@v1 | |
| with: | |
| args: -O docs/manticore.tag https://tatami-inc.github.io/manticore/manticore.tag | |
| - name: Doxygen Action | |
| uses: mattnotmitt/doxygen-action@v1.1.0 | |
| with: | |
| working-directory: docs/ | |
| - name: GH Pages Deployment | |
| uses: JamesIves/github-pages-deploy-action@4.1.3 | |
| with: | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs/html | |
| target-folder: docs/ | |
| clean: true # Automatically remove deleted files from the deploy branch |