Add support for arguments description (#623) #503
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
| # Generate the complete documentation then upload to the website under the master section | |
| name: "Doc generation" | |
| on: | |
| pull_request: ~ | |
| push: | |
| branches: | |
| - master | |
| release: | |
| types: | |
| - created | |
| jobs: | |
| doc-generation: | |
| name: "Doc generation" | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Checkout" | |
| uses: "actions/checkout@v4" | |
| - name: "Setup NodeJS" | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: '16.x' | |
| - name: "Yarn install" | |
| run: yarn install | |
| working-directory: "website" | |
| - name: "Yarn build" | |
| run: yarn run build | |
| working-directory: "website" | |
| - name: "Deploy website" | |
| if: "${{ github.event_name == 'push' || github.event_name == 'release' }}" | |
| uses: JamesIves/[email protected] | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: website/build # The folder the action should deploy. | |
| clean: true # Automatically remove deleted files from the deploy branch |