Merge pull request #188 from lyrasis/documenting-iterative-cleanup #191
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 & deploy documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| name: Update gh-pages with docs | |
| steps: | |
| - name: Checkout this repo | |
| uses: actions/checkout@v3 | |
| - name: Set up Ruby | |
| uses: ruby/setup-ruby@v1 | |
| with: | |
| ruby-version: "2.7" | |
| - name: Install yard | |
| run: gem install yard --no-document | |
| - name: Install redcarpet | |
| run: gem install redcarpet | |
| - name: Build YARD Ruby Documentation | |
| run: yardoc | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs | |
| publish_branch: gh-pages |