Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate apidoc on build #336

Merged
merged 11 commits into from
Dec 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"plugins": [
"react"
],
"ignorePatterns": ["node_modules", ".next", "apidoc", "public/static/js", "server/tracker/GpsTracker.js"],
"ignorePatterns": ["node_modules", ".next", ".build", "public/static/js", "server/tracker/GpsTracker.js"],
"rules": {
"array-callback-return": "warn",
"arrow-body-style": "warn",
Expand Down
26 changes: 26 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: GitHub Page & API Documentation

on:
push:
branches:
- master

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- name: Use Node.js
uses: actions/setup-node@v1

- name: Generate API Documentation
run: npm run generateapidoc && mv .build/apidoc . # Move the apidoc build artifacts so the links in README.md work

- name: Deploy Page
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./
enable_jekyll: true
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ public/static/lastwebcamframe.jpg
public/static/trackerHistoryExport.json
# static/placeholder/frames/
*.weights
.env
.env
.build
784 changes: 0 additions & 784 deletions apidoc/api_data.js

This file was deleted.

784 changes: 0 additions & 784 deletions apidoc/api_data.json

This file was deleted.

18 changes: 0 additions & 18 deletions apidoc/api_project.js

This file was deleted.

18 changes: 0 additions & 18 deletions apidoc/api_project.json

This file was deleted.