-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Commit documentation update in workflow
- Loading branch information
Showing
147 changed files
with
3,181 additions
and
185 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,20 @@ | ||
name: Build Documentation | ||
|
||
on: | ||
pull_request: | ||
types: [opened, synchronize, reopened] | ||
|
||
# Runs on pushes targeting the default branch | ||
push: | ||
branches: ["main"] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
permissions: | ||
contents: write | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v4 | ||
with: | ||
ref: ${{ github.event.pull_request.head.ref }} | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
|
@@ -25,6 +29,7 @@ jobs: | |
- name: Install Doxygen | ||
run: | | ||
cd .. | ||
wget https://www.doxygen.nl/files/doxygen-1.9.7.linux.bin.tar.gz | ||
tar -xzvf doxygen-1.9.7.linux.bin.tar.gz | ||
cd doxygen-1.9.7 | ||
|
@@ -34,11 +39,9 @@ jobs: | |
run: | | ||
make -C docs html # This assumes your Sphinx configuration is in a 'docs' folder | ||
# - name: Deploy to GitHub Pages (optional) | ||
# Uncomment the following lines if you want to deploy to GitHub Pages | ||
# run: | | ||
# git checkout gh-pages | ||
# cp -r docs/_build/html/* . | ||
# git add . | ||
# git commit -m "Update documentation" | ||
# git push origin gh-pages | ||
- name: Add and commit | ||
uses: EndBug/[email protected] | ||
with: | ||
author_name: UMLDev Clang Robot | ||
author_email: [email protected] | ||
message: 'Update documentation' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,6 @@ name: Build Debians | |
on: | ||
push: | ||
tags: | ||
- 'v*' | ||
|
||
jobs: | ||
build_debians: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
docs/doxyoutput | ||
docs/api | ||
docs/_build/doctrees | ||
|
||
.pre-commit-config.yaml |
Binary file modified
BIN
+100 KB
(110%)
docs/_build/doctrees/api/classpsdk__ros2_1_1PSDKWrapper.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1a17ca4f6fd2eb12cf64e022939d0900b2.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1a1816a36f3888d09183e5b47530f58094.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1a216a0f6643f4c894f88676591395b589.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1a3cdb1c583b523f495811dc7d987a7390.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1a434b8bbb7de051ce77a5f6b43732b8b6.doctree
Binary file not shown.
Binary file added
BIN
+5.77 KB
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1a476f0524e1f8786c87ff28bfc1f4762b.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1a672dc0a6f070eb5ea4881671fb3eacc0.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1a804716d718d21b16e1f1112978b41100.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1a83cf7c8196bd46f967ef83363daa14f4.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1aa64d57597f8d524decbd26a340fd276f.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1aa8526dc4ab91ca07a3b3c3a4ea85fbc6.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1ab4fbedd889d0f20727091061bcd68f2e.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1ac178df54baca74a030bdcba4dd98ab58.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1ace39a8993de63dc6fe84e5bda03152af.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1ade5163ec494976ea583183ec2f924a7e.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1ae57456a5fca2e24c5d9f7fa05fc2a29a.doctree
Binary file not shown.
Binary file added
BIN
+5.8 KB
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1af868e357aa8a19fb0f82ab9627863c40.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
.../doctrees/api/define_psdk__wrapper__utils_8hpp_1afd61c263db1b5625781a5f92e7073c9f.doctree
Binary file not shown.
Binary file added
BIN
+5.64 KB
...build/doctrees/api/dir__home_runner_work_psdk_ros2_psdk_ros2_psdk_wrapper_include.doctree
Binary file not shown.
Binary file added
BIN
+5 KB
...s/api/dir__home_runner_work_psdk_ros2_psdk_ros2_psdk_wrapper_include_psdk_wrapper.doctree
Binary file not shown.
Binary file not shown.
Binary file modified
BIN
-42 Bytes
(100%)
...es/api/enum_namespacepsdk__ros2_1_1psdk__utils_1a1c1b422ed436f6cd56ed3e85259b1cc2.doctree
Binary file not shown.
Binary file modified
BIN
-29 Bytes
(100%)
...es/api/enum_namespacepsdk__ros2_1_1psdk__utils_1a89ed1f3637656baf570fb7bacdab42d1.doctree
Binary file not shown.
Binary file modified
BIN
-30 Bytes
(100%)
...es/api/enum_namespacepsdk__ros2_1_1psdk__utils_1a92f4aaf0d4432a619294998d6b83fc5f.doctree
Binary file not shown.
Binary file modified
BIN
-29 Bytes
(100%)
...es/api/enum_namespacepsdk__ros2_1_1psdk__utils_1afc7b73c5ce68bcb204fc5938107fbc35.doctree
Binary file not shown.
Binary file modified
BIN
+1.31 KB
(100%)
docs/_build/doctrees/api/file_psdk_wrapper_include_psdk_wrapper_psdk_wrapper.hpp.doctree
Binary file not shown.
Binary file modified
BIN
+1.39 KB
(110%)
..._build/doctrees/api/file_psdk_wrapper_include_psdk_wrapper_psdk_wrapper_utils.hpp.doctree
Binary file not shown.
Binary file modified
BIN
-28 Bytes
(100%)
...pi/function_namespacepsdk__ros2_1_1psdk__utils_1a1cee8eb9089f9cdd6954643fe9ddb8fa.doctree
Binary file not shown.
Binary file modified
BIN
-28 Bytes
(100%)
...pi/function_namespacepsdk__ros2_1_1psdk__utils_1a38b91729bab1f1f18fcb178c240e5996.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified
BIN
+6.7 KB
(150%)
docs/_build/doctrees/api/namespace_psdk_ros2__psdk_utils.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(99%)
docs/_build/doctrees/api/namespace_rclcpp_lifecycle.doctree
Binary file not shown.
Binary file modified
BIN
+8.01 KB
(110%)
...trees/api/program_listing_file_psdk_wrapper_include_psdk_wrapper_psdk_wrapper.hpp.doctree
Binary file not shown.
Binary file modified
BIN
+6.44 KB
(140%)
...api/program_listing_file_psdk_wrapper_include_psdk_wrapper_psdk_wrapper_utils.hpp.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
docs/_build/doctrees/api/structpsdk__ros2_1_1PSDKWrapper_1_1PSDKParams.doctree
Binary file not shown.
Binary file modified
BIN
-20 Bytes
(100%)
docs/_build/doctrees/api/structpsdk__ros2_1_1psdk__utils_1_1DJITopic.doctree
Binary file not shown.
Binary file not shown.
Binary file modified
BIN
-22 Bytes
(100%)
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1a056a11560f4058993e731cb606039171.doctree
Binary file not shown.
Binary file modified
BIN
-27 Bytes
(100%)
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1a19efcbe765814c40659fcb303e19ea80.doctree
Binary file not shown.
Binary file added
BIN
+10.5 KB
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1a25b5bdc6b83e7e91a184e13bdeb8f2d0.doctree
Binary file not shown.
Binary file added
BIN
+10.9 KB
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1a2859d3cb5ccdefe10b59158f1cc0330b.doctree
Binary file not shown.
Binary file modified
BIN
-36 Bytes
(100%)
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1a42c4ed557cf13c401fe66a3b8826b771.doctree
Binary file not shown.
Binary file added
BIN
+29.4 KB
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1a5af327ecb9620374ea934c884789da4a.doctree
Binary file not shown.
Binary file modified
BIN
-37 Bytes
(100%)
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1a65928a00e249fdab67d967b5641c0ff5.doctree
Binary file not shown.
Binary file added
BIN
+10.5 KB
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1a6c9b64301f5ff418a4ff83827cdda5fb.doctree
Binary file not shown.
Binary file added
BIN
+10.2 KB
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1a94342b9901406839d815a30945727ec6.doctree
Binary file not shown.
Binary file modified
BIN
-27 Bytes
(100%)
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1a963babcfcf8114ccf97f1cc1b1e69214.doctree
Binary file not shown.
Binary file added
BIN
+8.49 KB
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1aa04e9e34d817c7b79ab65f9938e98046.doctree
Binary file not shown.
Binary file added
BIN
+35.1 KB
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1aa3f2a7dc25f13d6772d2e870daeffcc7.doctree
Binary file not shown.
Binary file added
BIN
+10.6 KB
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1ae3ae1fd093f7f7271d7016d1165f9a4b.doctree
Binary file not shown.
Binary file added
BIN
+10.5 KB
...pi/variable_namespacepsdk__ros2_1_1psdk__utils_1aff06f7e1b053d8319aed96924d0fd825.doctree
Binary file not shown.
Binary file modified
BIN
-29 Bytes
(100%)
...uild/doctrees/api/variable_namespacepsdk__ros2_1af2c97c9468e6c188f8f95d0b3f021a24.doctree
Binary file not shown.
Binary file not shown.
Binary file modified
BIN
+197 Bytes
(100%)
docs/_build/doctrees/documentation/GettingStarted.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
14 changes: 14 additions & 0 deletions
14
...api/define_psdk__wrapper__utils_8hpp_1a476f0524e1f8786c87ff28bfc1f4762b.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
.. _exhale_define_psdk__wrapper__utils_8hpp_1a476f0524e1f8786c87ff28bfc1f4762b: | ||
|
||
Define MAX_NUMBER_OF_RETRIES | ||
============================ | ||
|
||
- Defined in :ref:`file_psdk_wrapper_include_psdk_wrapper_psdk_wrapper_utils.hpp` | ||
|
||
|
||
Define Documentation | ||
-------------------- | ||
|
||
|
||
.. doxygendefine:: MAX_NUMBER_OF_RETRIES | ||
:project: C++ API Documentation |
14 changes: 14 additions & 0 deletions
14
...api/define_psdk__wrapper__utils_8hpp_1af868e357aa8a19fb0f82ab9627863c40.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
.. _exhale_define_psdk__wrapper__utils_8hpp_1af868e357aa8a19fb0f82ab9627863c40: | ||
|
||
Define ALTITUDE_TOPICS_MAX_FREQ | ||
=============================== | ||
|
||
- Defined in :ref:`file_psdk_wrapper_include_psdk_wrapper_psdk_wrapper_utils.hpp` | ||
|
||
|
||
Define Documentation | ||
-------------------- | ||
|
||
|
||
.. doxygendefine:: ALTITUDE_TOPICS_MAX_FREQ | ||
:project: C++ API Documentation |
21 changes: 21 additions & 0 deletions
21
...rces/api/dir__home_runner_work_psdk_ros2_psdk_ros2_psdk_wrapper_include.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
.. _dir__home_runner_work_psdk_ros2_psdk_ros2_psdk_wrapper_include: | ||
|
||
|
||
Directory include | ||
================= | ||
|
||
|
||
|exhale_lsh| :ref:`Parent directory <dir_psdk_wrapper>` (``psdk_wrapper``) | ||
|
||
.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS | ||
|
||
|
||
*Directory path:* ``/home/runner/work/psdk_ros2/psdk_ros2/psdk_wrapper/include`` | ||
|
||
Subdirectories | ||
-------------- | ||
|
||
- :ref:`dir__home_runner_work_psdk_ros2_psdk_ros2_psdk_wrapper_include_psdk_wrapper` | ||
|
||
|
||
|
16 changes: 16 additions & 0 deletions
16
..._home_runner_work_psdk_ros2_psdk_ros2_psdk_wrapper_include_psdk_wrapper.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
.. _dir__home_runner_work_psdk_ros2_psdk_ros2_psdk_wrapper_include_psdk_wrapper: | ||
|
||
|
||
Directory psdk_wrapper | ||
====================== | ||
|
||
|
||
|exhale_lsh| :ref:`Parent directory <dir__home_runner_work_psdk_ros2_psdk_ros2_psdk_wrapper_include>` (``/home/runner/work/psdk_ros2/psdk_ros2/psdk_wrapper/include``) | ||
|
||
.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS | ||
|
||
|
||
*Directory path:* ``/home/runner/work/psdk_ros2/psdk_ros2/psdk_wrapper/include/psdk_wrapper`` | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.