Added doc builder action, fleshed out the README. #1
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: | |
| doxygenator: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| - name: Restore the node modules | |
| uses: actions/cache@v4 | |
| with: | |
| path: '**/node_modules' | |
| key: modules-${{ hashFiles('**/package.json') }} | |
| - name: Install dependencies | |
| run: npm i --include-dev | |
| - name: Run JSDoc | |
| run: npm run jsdoc | |
| - name: GH Pages Deployment | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs/built | |
| target-folder: docs | |
| clean: true # Automatically remove deleted files from the deploy branch |