Skip to content

Commit d6667cb

Browse files
committed
Add a notice of active development and unstable API to Sphinx Dev and API docs.
1 parent aaf1946 commit d6667cb

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/pages/api_documentation.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ will only be interested in the :class:`.BaseNode` and :class:`.PoseEstimator` cl
88

99
.. _GISNav ROS 2 package: https://gitlab.com/px4-ros2-map-nav/python_px4_ros2_map_nav
1010

11+
.. note::
12+
GISNav is under active development and stability of the API is not guaranteed. Use a specific commit or version tag
13+
to mitigate the impact of breaking changes.
14+
1115
Indices and Tables
1216
=================================================
1317
Use the search in the sidebar or these indices to find what you are looking for.

docs/pages/developer_guide.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ Developer Guide
66
GISNav is untested and has only been demonstrated in a software-in-the-loop (SITL) simulation environment.
77
Do not use this software for real drone flights.
88

9+
.. note::
10+
GISNav is under active development and stability of the API is not guaranteed. Use a specific commit or version tag
11+
to mitigate the impact of breaking changes.
12+
913
This section provides instruction on how you can integrate GISNav with your project as well as configure and extend
1014
it to match your use case.
1115

0 commit comments

Comments
 (0)