add warning admonition

eclipse-zenoh · Dec 4, 2024 · 5310bec · 5310bec
1 parent 800a60c
commit 5310bec
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -69,7 +69,7 @@ module zenoh
     :undoc-members:
 
 module zenoh.handlers
-============
+=====================
 
 .. automodule:: zenoh.handlers
     :members:

diff --git a/zenoh/__init__.pyi b/zenoh/__init__.pyi
@@ -33,7 +33,7 @@ _PythonCallback = Callable[[_T], Any]
 _PythonHandler = tuple[_PythonCallback[_T], _H]
 
 def unstable(original):
-    _WARNING = "Warning: This API has been marked as unstable: it works as advertised, but it may be changed in a future release."
+    _WARNING = ".. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release."
     if original.__doc__:
         original.__doc__ += "\n" + _WARNING
     else: