Skip to content

Commit be1729e

Browse files
authoredNov 4, 2023
Build docs via CI
1 parent 8538488 commit be1729e

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed
 

‎.github/workflows/test.yml

+20
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,23 @@ jobs:
4141

4242
- name: Test doc examples
4343
run: nimble doc --warningAsError:BrokenLink:on --project src/ponairi.nim
44+
45+
deploy:
46+
name: Documentation
47+
needs: test
48+
permissions:
49+
pages: write # To deploy to Pages
50+
id-token: write # Verify deployment
51+
runs-on: ubuntu-latest
52+
if: github.ref == 'refs/heads/master'
53+
steps:
54+
- uses: actions/checkout@v4
55+
56+
- name: "Setup nim"
57+
uses: jiro4989/setup-nim-action@v1
58+
59+
- name: "Build documentation"
60+
uses: ire4ever1190/nim-docs-action@v1
61+
with:
62+
main-file: "src/ponairi.nim"
63+
deploy: "pages"

‎readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Simple ORM to handle basic CRUD tasks. Future plans are to expand the query generation to make needing to write SQL less common
44

5-
[Docs here](https://tempdocs.netlify.app/ponairi/stable/ponairi.html)
5+
[Docs here](https://ire4ever1190.github.io/ponairi/ponairi.html)
66

77
### Create
88

0 commit comments

Comments
 (0)
Please sign in to comment.