Skip to content

Commit d0f396b

Browse files
committed
Merge branch 'doxygen-documentation'
2 parents 647b6d2 + 7bef6d8 commit d0f396b

11 files changed

Lines changed: 4207 additions & 3 deletions
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Deploy Doxygen to GitHub Pages
2+
3+
on:
4+
push:
5+
# branches:
6+
# - "main"
7+
# tags:
8+
# - "v*"
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
jobs:
16+
build:
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- uses: actions/checkout@v4
21+
22+
- name: Install Doxygen
23+
run: |
24+
sudo apt-get update
25+
sudo apt-get install -y doxygen graphviz
26+
27+
- name: Build docs
28+
run: |
29+
mkdir -p doxygen/html
30+
doxygen Doxyfile
31+
32+
- name: Upload Pages artifact
33+
uses: actions/upload-pages-artifact@v3
34+
with:
35+
path: ./doxygen/html
36+
37+
deploy:
38+
needs: build
39+
runs-on: ubuntu-latest
40+
environment:
41+
name: github-pages
42+
url: ${{ steps.deployment.outputs.page_url }}
43+
44+
steps:
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,3 +204,5 @@ cython_debug/
204204
marimo/_static/
205205
marimo/_lsp/
206206
__marimo__/
207+
208+
doxygen/html

.vscode/tasks.json

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"label": "Generate Doxygen Docs",
6+
"type": "shell",
7+
"command": "doxygen",
8+
"args": [
9+
"Doxyfile"
10+
],
11+
"group": {
12+
"kind": "build",
13+
"isDefault": false
14+
},
15+
"presentation": {
16+
"echo": true,
17+
"reveal": "always",
18+
"panel": "shared"
19+
},
20+
"problemMatcher": []
21+
}
22+
]
23+
}

0 commit comments

Comments
 (0)