Switch to github action doc generator.
This commit is contained in:
parent
00190ad7fb
commit
6e2906d989
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 }}
|
|
@ -6,7 +6,7 @@
|
||||||
|
|
||||||
![Github Actions](https://github.com/treeform/vmath/workflows/Github%20Actions/badge.svg)
|
![Github Actions](https://github.com/treeform/vmath/workflows/Github%20Actions/badge.svg)
|
||||||
|
|
||||||
[API reference](https://nimdocs.com/treeform/vmath)
|
[API reference](https://treeform.github.io/vmath)
|
||||||
|
|
||||||
This library has no dependencies other than the Nim standard library.
|
This library has no dependencies other than the Nim standard library.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue