Skip to content

Commit

Permalink
[DOC] add missing arsdk/*.proto documentation
Browse files Browse the repository at this point in the history
- connectivity.proto
- privacy.proto
- controller_privacy.proto
  • Loading branch information
ndessart committed Dec 15, 2023
1 parent 7d5acec commit e01b7a4
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 0 deletions.
21 changes: 21 additions & 0 deletions src/olympe/doc/arsdkng.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,13 @@ Messages Reference Documentation

arsdkng_common

.. toctree::
:caption: Connectivity feature
:maxdepth: 1
:titlesonly:

arsdkng_connectivity

.. toctree::
:caption: Controller Info feature
:maxdepth: 1
Expand All @@ -94,6 +101,13 @@ Messages Reference Documentation

arsdkng_controller_network

.. toctree::
:caption: Controller Privacy feature
:maxdepth: 1
:titlesonly:

arsdkng_controller_privacy

.. toctree::
:caption: Debug feature
:maxdepth: 1
Expand Down Expand Up @@ -276,6 +290,13 @@ Messages Reference Documentation

arsdkng_precise_home

.. toctree::
:caption: Privacy feature
:maxdepth: 1
:titlesonly:

arsdkng_privacy

.. toctree::
:caption: RTH feature
:maxdepth: 1
Expand Down
8 changes: 8 additions & 0 deletions src/olympe/doc/arsdkng_connectivity.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Connectivity feature
^^^^^^^^^^^^^^^^^^^^

.. auto_arsdkfeature:: connectivity.Command

.. auto_arsdkfeature:: connectivity.Event

.. auto_arsdkfeature:: connectivity
6 changes: 6 additions & 0 deletions src/olympe/doc/arsdkng_controller_privacy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Controller Privacy feature
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. auto_arsdkfeature:: controllerPrivacy.Command

.. auto_arsdkfeature:: controllerPrivacy.Event
8 changes: 8 additions & 0 deletions src/olympe/doc/arsdkng_privacy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Privacy feature
^^^^^^^^^^^^^^^

.. auto_arsdkfeature:: privacy.Command

.. auto_arsdkfeature:: privacy.Event

.. auto_arsdkfeature:: privacy

0 comments on commit e01b7a4

Please sign in to comment.