-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a3a27e1
commit 2bf45f9
Showing
3 changed files
with
41 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
on: | ||
push: | ||
branches: [main, devel] | ||
pull_request: | ||
branches: [main] | ||
paths-ignore: | ||
- "**/*.md" | ||
- "**/*.py" | ||
- "LICENSE" | ||
|
||
jobs: | ||
docs: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v1 | ||
with: | ||
fetch-depth: 0 | ||
- name: Setup Go | ||
uses: actions/setup-go@v5 | ||
with: | ||
go-version-file: go.mod | ||
- name: Build documentation | ||
run: | | ||
go install go.abhg.dev/doc2go@latest | ||
doc2go -out docs ./... | ||
- name: Deploy documentation to GitHub pages | ||
if: github.ref == 'refs/heads/main' | ||
uses: peaceiris/[email protected] | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
PUBLISH_BRANCH: gh-pages | ||
PUBLISH_DIR: docs | ||
- name: Upload documentation | ||
uses: actions/upload-artifact@v1 | ||
with: | ||
name: documentation | ||
path: docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,6 @@ samples/ | |
### Documentation | ||
# Generated docs | ||
docs/ | ||
doc/ | ||
|
||
### JetBrains | ||
# User-specific stuff | ||
|