From b4f4f03b16ee14651161c002a0bd2c84f5866a9d Mon Sep 17 00:00:00 2001
From: sven-hoek <herrlauch@gmail.com>
Date: Thu, 8 May 2025 09:42:02 +0800
Subject: [PATCH 1/2] Add GH Action to publish Doxygen
---
.github/workflows/doxygen-gh-pages.yml | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
create mode 100644 .github/workflows/doxygen-gh-pages.yml
diff --git a/.github/workflows/doxygen-gh-pages.yml b/.github/workflows/doxygen-gh-pages.yml
new file mode 100644
index 000000000..b8fb8f46b
--- /dev/null
+++ b/.github/workflows/doxygen-gh-pages.yml
@@ -0,0 +1,18 @@
+name: Doxygen GitHub Pages Deploy Action
+
+on:
+ push:
+ branches:
+ - main
+ - master
+
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ steps:
+ - uses: DenverCoder1/doxygen-github-pages-action@v2.0.0
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ folder: doc/html
From 66cb12fb92ba411b14f56997416d936adbaf78e7 Mon Sep 17 00:00:00 2001
From: sven-hoek <herrlauch@gmail.com>
Date: Thu, 8 May 2025 09:52:08 +0800
Subject: [PATCH 2/2] Add link in README
---
README.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/README.md b/README.md
index e6aa9be43..6fda200c7 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,8 @@ to visualize, record, replay and analyze state transitions.
You can learn about the main concepts, the API and the tutorials here: https://www.behaviortree.dev/
+An automatically generated API documentation can be found here: https://BehaviorTree.github.io/BehaviorTree.CPP/
+
If the documentation doesn't answer your questions and/or you want to
connect with the other **BT.CPP** users, visit [our forum](https://github.com/BehaviorTree/BehaviorTree.CPP/discussions)