2023-05-17 07:51:10 +00:00
|
|
|
|
|
|
|
name: Docs
|
|
|
|
|
2024-03-28 12:26:29 +00:00
|
|
|
on:
|
|
|
|
push:
|
|
|
|
branches: ["master"]
|
|
|
|
|
|
|
|
permissions:
|
|
|
|
contents: read
|
|
|
|
pages: write
|
|
|
|
id-token: write
|
|
|
|
|
|
|
|
concurrency:
|
|
|
|
group: "pages"
|
|
|
|
cancel-in-progress: false
|
2023-05-17 07:51:10 +00:00
|
|
|
|
|
|
|
jobs:
|
2024-03-28 12:26:29 +00:00
|
|
|
docs-deploy:
|
2023-05-17 07:51:10 +00:00
|
|
|
runs-on: ubuntu-latest
|
2024-03-28 12:26:29 +00:00
|
|
|
environment:
|
|
|
|
name: github-page
|
|
|
|
url: ${{ steps.deployement.outputs.page_url }}
|
2023-05-17 07:51:10 +00:00
|
|
|
steps:
|
2024-03-28 12:26:29 +00:00
|
|
|
- uses: actions/checkout@v4
|
2023-05-17 07:51:10 +00:00
|
|
|
- name: Install dependencies
|
|
|
|
run: |
|
|
|
|
sudo apt-get update
|
|
|
|
sudo apt-get install build-essential naturaldocs
|
2024-03-28 12:26:29 +00:00
|
|
|
- name: generate-docs
|
2023-05-17 07:51:10 +00:00
|
|
|
run: |
|
|
|
|
make docs
|
2024-03-28 12:26:29 +00:00
|
|
|
- name: setup-pages
|
|
|
|
uses: actions/configure-pages@v4
|
|
|
|
- name: upload-artifact
|
|
|
|
uses: actions/upload-pages-artifact@v3
|
2023-05-17 07:51:10 +00:00
|
|
|
with:
|
2024-03-28 12:26:29 +00:00
|
|
|
path: './docs/html'
|
|
|
|
- name: deploy-github-page
|
|
|
|
id: deployment
|
|
|
|
uses: actions/deploy-pages@v4
|
|
|
|
|
2023-05-17 07:51:10 +00:00
|
|
|
|