From ad7492a959d7b1d7729fa6eec86d33ded5391aeb Mon Sep 17 00:00:00 2001 From: treeform Date: Wed, 10 May 2023 17:21:32 -0700 Subject: [PATCH] Switch to github action doc generator. --- .github/workflows/docs.yml | 26 ++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..683a6b5 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,26 @@ +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 }} diff --git a/README.md b/README.md index 0e60229..051fdba 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This library is being actively developed and we'd be happy for you to use it. ![Github Actions](https://github.com/treeform/pixie/workflows/Github%20Actions/badge.svg) -[API reference](https://nimdocs.com/treeform/pixie) +[API reference](https://treeform.github.io/pixie) [Pixie Book](https://github.com/treeform/pixiebook)