5d303a22e2
Related #11. Builds docs to the gh-pages branch on every push to master. Also updates all dead links to point to live ones (or ones that will be live after this is merged). Uses three third-party gh actions: * leafo/gh-actions-lua@v8 * leafo/gh-actions-luarocks@v4 * peaceiris/actions-gh-pages@v3 * This receives secrets.GITHUB_TOKEN Also switches to the new ldoc css and moves doc output folder to ./doc/out which is less confusing when configuring than ./doc/doc. Once merged, docs will be available on https://excessive.github.io/cpml/ Currently, you can see the built docs on https://idbrii.github.io/love-cpml/
32 lines
878 B
YAML
32 lines
878 B
YAML
# Based on https://gist.github.com/domenic/ec8b0fc8ab45f39403dd
|
|
name: Documentation
|
|
|
|
on:
|
|
pull_request: # Build on pull requests to ensure they don't break docs.
|
|
branches:
|
|
- master
|
|
push: # We'll only push new docs when master is updated (see below).
|
|
branches:
|
|
- master
|
|
|
|
jobs:
|
|
build:
|
|
name: Build Docs
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- name: Setup Lua
|
|
uses: leafo/gh-actions-lua@v8
|
|
with:
|
|
luaVersion: 5.4
|
|
- name: Setup Lua Rocks
|
|
uses: leafo/gh-actions-luarocks@v4
|
|
- name: Setup and run ldoc
|
|
run: bash ./doc/install_and_build_docs
|
|
- name: Deploy
|
|
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: ./doc/out
|