docs: add github actions to deploy document using doxygen (#33)

* chore: add github actions to deploy document using doxygen Signed-off-by: ktro2828 <[email protected]> * docs: update README Signed-off-by: ktro2828 <[email protected]> --------- Signed-off-by: ktro2828 <[email protected]>
ktro2828 · Aug 16, 2024 · 2d06736 · 2d06736
1 parent 71b8025
commit 2d06736
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 4 deletions.
diff --git a/.github/workflows/doxygen-gh-pages.yaml b/.github/workflows/doxygen-gh-pages.yaml
@@ -0,0 +1,18 @@
+name: doxygen-github-pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: DenverCoder1/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          folder: docs/html
+          config_file: Doxyfile
diff --git a/README.md b/README.md
@@ -1,6 +1,10 @@
-# AWViz ROS
+# AWViz-ROS
 
-AWViz offers a 3D ROS viewer for [Autoware](https://autoware.org) powered by [Rerun](https://rerun.io).
+AWViz-ROS features a ROS 3D viewer for [Autoware](https://autoware.org) powered by [Rerun](https://rerun.io).
+
+<div align="center">
+    <img src="./docs/images/awviz-viewer.png" alt="awviz-viewer">
+</div>
 
 ## Build & Run
 

diff --git a/docs/MAIN.md b/docs/MAIN.md
@@ -1,6 +1,10 @@
-# AWViz ROS {#mainpage}
+# AWViz-ROS {#mainpage}
 
-AWViz offers a 3D ROS viewer for [Autoware](https://autoware.org) powered by [Rerun](https://rerun.io).
+AWViz-ROS features a ROS 3D viewer for [Autoware](https://autoware.org) powered by [Rerun](https://rerun.io).
+
+<div align="center">
+    <img src="./images/awviz-viewer.png" alt="awviz-viewer">
+</div>
 
 ## Build & Run
 

diff --git a/docs/images/awviz-viewer.png b/docs/images/awviz-viewer.png