mirror of
https://github.com/HenkKalkwater/harbour-sailfin.git
synced 2025-09-05 18:22:46 +00:00
docs: Add Doxygen and project-related documentation
This commit is contained in:
parent
c5541b0b16
commit
720a1ed5ff
14 changed files with 3186 additions and 1 deletions
40
.github/workflows/doxygen.yaml
vendored
Normal file
40
.github/workflows/doxygen.yaml
vendored
Normal file
|
@ -0,0 +1,40 @@
|
|||
name: doxygen
|
||||
run-name: Generate and deploy Doxygen documentation
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- "master"
|
||||
workflow_dispatch: {}
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/configure-pages@v3
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.9'
|
||||
cache: 'pip' # caching pip dependencies
|
||||
- run: pip install doxyqml
|
||||
- name: Doxygen
|
||||
uses: uses: mattnotmitt/doxygen-action@v1.9.5
|
||||
- name: Upload GitHub pages artifact
|
||||
uses: "actions/upload-pages-artifact@v2"
|
||||
with:
|
||||
path: "doxygen/html/"
|
||||
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
steps:
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: "actions/deploy-pages@v2"
|
Loading…
Add table
Add a link
Reference in a new issue