Skip to content

Commit 8d37bd7

Browse files
committed
doc ci
1 parent 97afa9e commit 8d37bd7

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

.github/workflows/doc.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: doc
2+
3+
on:
4+
push:
5+
branches: [ pyrev ]
6+
tags:
7+
- '*'
8+
# Allows you to run this workflow manually from the Actions tab
9+
workflow_dispatch:
10+
11+
jobs:
12+
gendoc:
13+
name: Generate documentation
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Configure Git Credentials
20+
run: |
21+
git config user.name github-actions[bot]
22+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
23+
24+
- name : Install dependencies
25+
run: sudo apt-get install -y git cmake build-essential doxygen graphviz python3-dev python3-pip pybind11-dev libglm-dev libglfw3-dev libpng-dev libjpeg-dev libeigen3-dev python3-numpy python3-sphinx python3-sphinx-rtd-theme
26+
27+
- name: Install python dependencies
28+
run: python -m pip install mkdocs mkdocs-material
29+
30+
- name: Generate documentation
31+
run: cd docs && make all
32+
33+
- uses: actions/upload-artifact@v4
34+
with:
35+
name: site
36+
path: ./site/*
37+
38+
- name: Deploy documentation
39+
run: cd docs && make deploy

docs/Makefile

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,16 @@ py:
1313
mkdir -p build && cd build && cmake ../../ -DBUILD_PYTHON_BINDINGS=ON && make -j
1414
sphinx-build -b html . ./doc_py/
1515

16+
.PHONY: mkdocs
17+
mkdocs:
18+
@echo "Building MkDocs documentation..."
19+
cd .. && mkdocs build
20+
1621
.PHONY: all
17-
all: cpp py
22+
all: cpp py mkdocs
1823
@echo "All documentation built."
24+
25+
.PHONY: deploy
26+
deploy:
27+
@echo "Deploying documentation..."
28+
cd .. && mkdocs gh-deploy --force

0 commit comments

Comments
 (0)