diff options
author | Jo-Philipp Wich <jo@mein.io> | 2023-05-31 13:28:14 +0200 |
---|---|---|
committer | Jo-Philipp Wich <jo@mein.io> | 2023-07-12 10:45:21 +0200 |
commit | 70f93488b93e8baa5b090d427019e70da933eb33 (patch) | |
tree | 7c4b10cd827fdb51e457c3aaba3b0ede0c62d42b /.github | |
parent | e06f656f5043d5b86f6ccfb7f9b8447800623659 (diff) |
docs: add initial JSDoc infrastructure
Introduce the infrastructure for building ucode module documentation using
JSDoc annotations.
To build the documentation, run `npm install` followed by `npm run doc`.
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
Diffstat (limited to '.github')
-rw-r--r-- | .github/workflows/jsdoc.yml | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/.github/workflows/jsdoc.yml b/.github/workflows/jsdoc.yml new file mode 100644 index 0000000..b2eaefe --- /dev/null +++ b/.github/workflows/jsdoc.yml @@ -0,0 +1,33 @@ +name: GitHub pages + +on: + push: + branches: + - master + +jobs: + deploy: + if: github.repository == 'jow-/ucode' + 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: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/ + enable_jekyll: true |