Skip to content

Commit 8e9455c

Browse files
authored
📝 docs (#14)
1 parent d304167 commit 8e9455c

File tree

7 files changed

+134
-96
lines changed

7 files changed

+134
-96
lines changed

.github/workflows/docs.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Docs
2+
3+
on:
4+
workflow_dispatch:
5+
branches:
6+
- main
7+
workflow_call:
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
docs:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Setup Dart SDK
17+
uses: dart-lang/setup-dart@v1
18+
with:
19+
sdk: stable
20+
- id: checkout
21+
name: Checkout repository
22+
uses: actions/checkout@v4
23+
- id: install
24+
name: Install dependencies
25+
run: dart pub get
26+
- name: Build documentation
27+
run: dart doc .
28+
- name: Deploy to GitHub Pages
29+
uses: peaceiris/actions-gh-pages@v4
30+
with:
31+
publish_branch: gh-pages
32+
github_token: ${{ secrets.GITHUB_TOKEN }}
33+
publish_dir: doc/api/
34+
force_orphan: true

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@ pubspec.lock
88

99
# Coverage
1010
coverage/
11+
12+
# Docs
13+
doc/

0 commit comments

Comments
 (0)