Skip to content

Commit

Permalink
Commit documentation update in workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
biancabnd committed Jan 30, 2024
1 parent 5fd56c2 commit 4b7d6c0
Show file tree
Hide file tree
Showing 147 changed files with 3,181 additions and 185 deletions.
27 changes: 15 additions & 12 deletions .github/workflows/build_docs.yaml
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
Expand All @@ -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
Expand All @@ -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'
1 change: 0 additions & 1 deletion .github/workflows/upload-debians.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ name: Build Debians
on:
push:
tags:
- 'v*'

jobs:
build_debians:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
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 docs/_build/doctrees/api/classpsdk__ros2_1_1PSDKWrapper.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/api/dir_psdk_wrapper.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/api/library_root.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/api/namespace_psdk_ros2.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/api/namespace_rclcpp_lifecycle.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/api/unabridged_orphan.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/documentation/Contribute.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/documentation/GettingStarted.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/documentation/Introduction.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/documentation/ThePSDKWrapper.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
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
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
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`



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``



2 changes: 1 addition & 1 deletion docs/_build/html/_sources/api/dir_psdk_wrapper.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Directory psdk_wrapper
Subdirectories
--------------

- :ref:`dir__home_unmanned_umd2_ws_src_umd_robot_essentials_psdk_ros2_psdk_wrapper_include`
- :ref:`dir__home_runner_work_psdk_ros2_psdk_ros2_psdk_wrapper_include`



Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Includes

- ``osal_socket.h``

- ``psdk_interfaces/msg/altitude.hpp``
- ``psdk_interfaces/msg/control_mode.hpp``

- ``psdk_interfaces/msg/display_mode.hpp``

Expand All @@ -104,6 +104,8 @@ Includes

- ``psdk_interfaces/msg/position_fused.hpp``

- ``psdk_interfaces/msg/rc_connection_status.hpp``

- ``psdk_interfaces/msg/relative_obstacle_info.hpp``

- ``psdk_interfaces/msg/rtk_yaw.hpp``
Expand Down Expand Up @@ -194,6 +196,8 @@ Includes

- ``sensor_msgs/msg/nav_sat_fix.hpp``

- ``std_msgs/msg/bool.hpp``

- ``std_msgs/msg/float32.hpp``

- ``std_msgs/msg/u_int16.hpp``
Expand All @@ -204,6 +208,10 @@ Includes

- ``string``

- ``tf2_ros/static_transform_broadcaster.h``

- ``tf2_ros/transform_broadcaster.h``




Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ Defines

- :ref:`exhale_define_psdk__wrapper__utils_8hpp_1ace39a8993de63dc6fe84e5bda03152af`

- :ref:`exhale_define_psdk__wrapper__utils_8hpp_1af868e357aa8a19fb0f82ab9627863c40`

- :ref:`exhale_define_psdk__wrapper__utils_8hpp_1aa64d57597f8d524decbd26a340fd276f`

- :ref:`exhale_define_psdk__wrapper__utils_8hpp_1a434b8bbb7de051ce77a5f6b43732b8b6`
Expand All @@ -103,6 +105,8 @@ Defines

- :ref:`exhale_define_psdk__wrapper__utils_8hpp_1afd61c263db1b5625781a5f92e7073c9f`

- :ref:`exhale_define_psdk__wrapper__utils_8hpp_1a476f0524e1f8786c87ff28bfc1f4762b`

- :ref:`exhale_define_psdk__wrapper__utils_8hpp_1a672dc0a6f070eb5ea4881671fb3eacc0`

- :ref:`exhale_define_psdk__wrapper__utils_8hpp_1a216a0f6643f4c894f88676591395b589`
Expand Down
2 changes: 0 additions & 2 deletions docs/_build/html/_sources/api/library_root.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
Library API
===========

.. include:: page_view_hierarchy.rst.include

.. include:: class_view_hierarchy.rst.include

.. include:: file_view_hierarchy.rst.include
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,26 @@ Variables

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1a056a11560f4058993e731cb606039171`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1aa3f2a7dc25f13d6772d2e870daeffcc7`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1a5af327ecb9620374ea934c884789da4a`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1a2859d3cb5ccdefe10b59158f1cc0330b`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1ae3ae1fd093f7f7271d7016d1165f9a4b`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1a963babcfcf8114ccf97f1cc1b1e69214`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1a19efcbe765814c40659fcb303e19ea80`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1aa04e9e34d817c7b79ab65f9938e98046`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1aff06f7e1b053d8319aed96924d0fd825`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1a94342b9901406839d815a30945727ec6`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1a25b5bdc6b83e7e91a184e13bdeb8f2d0`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1a6c9b64301f5ff418a4ff83827cdda5fb`

- :ref:`exhale_variable_namespacepsdk__ros2_1_1psdk__utils_1a65928a00e249fdab67d967b5641c0ff5`
Loading

0 comments on commit 4b7d6c0

Please sign in to comment.