Skip to content

Commit

Permalink
add basic structure for reference and commit on workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
vinicvaz committed May 15, 2024
1 parent 49c7820 commit 2777071
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/deploy-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- docs
- fix/docs-workflows

jobs:
deploy:
Expand Down Expand Up @@ -39,6 +40,19 @@ jobs:
- name: Build website
run: cd docs/vame-docs-app && yarn build

- name: Commit pydoc-markdown files
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
GIT_STATUS=$(git status -s)
[[ ! -z "$GIT_STATUS" ]] && git add docs/* && git commit -m "auto-commit-docs" -a || echo "No changes to commit"
- name: Push changes
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: ${{ github.ref }}

# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
Expand Down
8 changes: 8 additions & 0 deletions docs/vame-docs-app/docs/reference/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "API reference",
"position": 3,
"link": {
"type": "generated-index",
"description": "VAME package API reference"
}
}

0 comments on commit 2777071

Please sign in to comment.