ci: add doc workflow

GitHub Actions to build and deploy doc to gh-pages.
This commit is contained in:
Aire-One 2021-10-21 19:07:33 +02:00
parent 31d7d7831b
commit 4660dc62f8
2 changed files with 41 additions and 1 deletions

View File

@ -11,5 +11,5 @@ charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.json]
[*.{json,yaml}]
indent_size = 2

40
.github/workflows/doc.yaml vendored Normal file
View File

@ -0,0 +1,40 @@
name: Build doc
on:
push:
branches: [$default-branch]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
# Cancel the previous run if it's still in progress
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Generate docs with LDoc
uses: lunarmodules/ldoc@v1.5.0
- name: Upload static files as artifact
id: deployment
uses: actions/upload-pages-artifact@v3
with:
path: doc/
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4