Switch to github action doc generator.
This commit is contained in:
parent
94eb5ea559
commit
ad7492a959
26
.github/workflows/docs.yml
vendored
Normal file
26
.github/workflows/docs.yml
vendored
Normal file
|
@ -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 }}
|
|
@ -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)
|
||||
|
||||
|
|
Loading…
Reference in a new issue