Generate documentation #8
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: generate-doc | |
| run-name: Generate documentation | |
| on: | |
| push: | |
| branches: | |
| - "main" | |
| paths: | |
| - "nimdoc.cfg" | |
| - "libtray.nimble" | |
| - "src/**" | |
| - ".github/workflows/**" | |
| workflow_dispatch: | |
| jobs: | |
| generate-doc: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Setup Nim | |
| uses: jiro4989/setup-nim-action@v1.5.0 | |
| with: | |
| nim-version: stable | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Generate documentation | |
| run: | | |
| nimble doc src/libtray | |
| echo "<!DOCTYPE html><html><head><meta http-equiv='Refresh' content='0; url=libtray.html'></head></html>" > htmldocs/index.html | |
| - name: Deploy to GitHub Pages | |
| if: success() | |
| uses: crazy-max/ghaction-github-pages@v4 | |
| with: | |
| build_dir: htmldocs | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |