Skip to content

Commit 3c62813

Browse files
authored
Add action to publish Doxygen documentation as GH Page (#972)
* Add GH Action to publish Doxygen * Add link in README
1 parent db6d3f7 commit 3c62813

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Doxygen GitHub Pages Deploy Action
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- master
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: write
14+
steps:
15+
- uses: DenverCoder1/doxygen-github-pages-action@v2.0.0
16+
with:
17+
github_token: ${{ secrets.GITHUB_TOKEN }}
18+
folder: doc/html

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ to visualize, record, replay and analyze state transitions.
3535

3636
You can learn about the main concepts, the API and the tutorials here: https://www.behaviortree.dev/
3737

38+
An automatically generated API documentation can be found here: https://BehaviorTree.github.io/BehaviorTree.CPP/
39+
3840
If the documentation doesn't answer your questions and/or you want to
3941
connect with the other **BT.CPP** users, visit [our forum](https://github.com/BehaviorTree/BehaviorTree.CPP/discussions)
4042

0 commit comments

Comments
 (0)