mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-07-03 02:23:20 +00:00
ef8da8054f
This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
30 lines
709 B
YAML
30 lines
709 B
YAML
name: Build documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [ master ]
|
|
tags:
|
|
|
|
jobs:
|
|
make_doc:
|
|
name: Build
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v1
|
|
|
|
- name: Build documentation
|
|
run: |
|
|
test -d bin || mkdir bin
|
|
test -f bin/illuaminate || wget -q -Obin/illuaminate https://squiddev.cc/illuaminate/linux-x86-64/illuaminate
|
|
chmod +x bin/illuaminate
|
|
bin/illuaminate doc-gen
|
|
|
|
- name: Upload documentation
|
|
run: .github/workflows/make-doc.sh 2> /dev/null
|
|
env:
|
|
SSH_KEY: ${{ secrets.SSH_KEY }}
|
|
SSH_USER: ${{ secrets.SSH_USER }}
|
|
SSH_HOST: ${{ secrets.SSH_HOST }}
|
|
SSH_PORT: ${{ secrets.SSH_PORT }}
|