CI: automatically update jsapi docs

Use a GitHub Action to keep the docs updated, the current onces are 14
month old and outdated.

Use latest jsdoc package

Add full URL to LuCI.html file in README.md

Ignore generated HTML files via .gitignore

Signed-off-by: Paul Spooren <mail@aparcar.org>
pull/5424/head
Paul Spooren 2021-10-06 16:35:46 -10:00
parent c1f972df1b
commit 56ef04849d
4 changed files with 40 additions and 2 deletions

31
.github/workflows/jsdoc.yml vendored 100644
View File

@ -0,0 +1,31 @@
name: GitHub pages
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Install
run: npm install
- name: Build
run: npm run doc
- name: Archive docs as artifact
uses: actions/upload-artifact@v2
with:
name: docs
path: ./docs/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
publish_dir: ./docs/

2
.gitignore vendored
View File

@ -12,3 +12,5 @@ modules/luci-base/src/jsmin
modules/luci-base/src/contrib/lemon
modules/luci-base/src/plural_formula.c
modules/luci-base/src/plural_formula.h
docs/jsapi/*
!docs/jsapi/README.md

View File

@ -0,0 +1,5 @@
# LuCI client side API documentation
You can browse the JavaScript apis provided by LuCI here. A good starting point
is the central [luci.js class](https://openwrt.github.io/luci/jsapi/LuCI.html).

View File

@ -3,7 +3,7 @@
"doc": "LC_ALL=C jsdoc -c jsdoc.conf.json -t node_modules/jaguarjs-jsdoc"
},
"devDependencies": {
"jsdoc": "^3.6.3",
"jaguarjs-jsdoc": "^1.1.0"
"jaguarjs-jsdoc": "^1.1.0",
"jsdoc": "^3.6.7"
}
}