From: Aurelien DARRAGON <adarragon@haproxy.com>
Date: Thu, 23 Nov 2023 12:47:54 +0000 (+0100)
Subject: DOC: lua: add sticktable class reference from Proxy.stktable
X-Git-Tag: v2.9-dev12~92
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=034461fd73634410d58f0225388a9e49e9636fb2;p=thirdparty%2Fhaproxy.git

DOC: lua: add sticktable class reference from Proxy.stktable

Add a reference hint for the sticktable class and mention it from
Proxy.stktable documentation to allow easy navigation from a web
browser.
---

diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst
index 5716312973..eadf2f2f38 100644
--- a/doc/lua-api/index.rst
+++ b/doc/lua-api/index.rst
@@ -1087,7 +1087,8 @@ Proxy class
 
 .. js:attribute:: Proxy.stktable
 
-  Contains a stick table object attached to the proxy.
+  Contains a stick table object of type :ref:`sticktable_class` attached to the
+  proxy.
 
 .. js:attribute:: Proxy.listeners
 
@@ -3730,6 +3731,8 @@ AppletTCP class
   :see: :js:func:`AppletTCP.unset_var`
   :see: :js:func:`AppletTCP.set_var`
 
+.. _sticktable_class:
+
 StickTable class
 ================