From e45b513b7ade83c34f633266b9916c417c339bdc Mon Sep 17 00:00:00 2001 From: dlesnoff <54949944+dlesnoff@users.noreply.github.com> Date: Wed, 17 May 2023 18:49:48 +0200 Subject: [PATCH] Workflow: Add documentation in gh-pages (#126) * Update CI nim version * Add guzba's recommended workflow to generate documentation on gh-pages * Reupdate the Nim CI version --------- Co-authored-by: Dimitri LESNOFF Co-authored-by: Miran --- .github/workflows/test.yaml | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index adee518..17611cc 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -17,7 +17,7 @@ jobs: matrix: nim-version: - '1.4.8' - - '1.6.10' + - '1.6.12' - 'devel' needs: before steps: @@ -28,3 +28,30 @@ jobs: - run: nimble install -y - run: nimble test - run: nimble checkExamples + +name: docs +on: + push: + branches: + - master +env: + nim-version: 'stable' + nim-src: src/${{ github.event.repository.name }}.nim + deploy-dir: .gh-pages +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: jiro4989/setup-nim-action@v1 + with: + nim-version: ${{ env.nim-version }} + - run: nimble install -Y + - run: nimble doc --index:on --project --git.url:https://github.com/${{ github.repository }} --git.commit:master --out:${{ env.deploy-dir }} ${{ env.nim-src }} + - name: "Copy to index.html" + run: cp ${{ env.deploy-dir }}/${{ github.event.repository.name }}.html ${{ env.deploy-dir }}/index.html + - name: Deploy documents + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ${{ env.deploy-dir }}