1berry/haproxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DOC: lua: silence "literal block ends without a blank line" Sphinx warnings

Browse Source 
When building html documentation from doc/lua-api/index.rst, sphinx
complains about some literal blocks ending without a blank line:

  "doc/lua-api/index.rst:534: WARNING: Literal block ends without a blank line; unexpected unindent."

Adding the missing blank lines to make sphinx happy
This commit is contained in:
Aurelien DARRAGON 2023-03-13 19:36:13 +01:00 committed by Christopher Faulet
parent b8038996e9
commit d5c80d7ab1
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/lua-api/index.rst
View File

@ -510,6 +510,7 @@ Core class
frontend http_frt frontend http_frt
mode http mode http
http-request lua.hello-world http-request lua.hello-world
.. ..
A second example using arguments A second example using arguments
@ -520,6 +521,7 @@ Core class
txn:Info("Hello world for " .. arg) txn:Info("Hello world for " .. arg)
end end
core.register_action("hello-world", { "tcp-req", "http-req" }, hello_world, 2) core.register_action("hello-world", { "tcp-req", "http-req" }, hello_world, 2)
.. ..
This example code is used in HAProxy configuration like this: This example code is used in HAProxy configuration like this:
@ -529,6 +531,7 @@ Core class
frontend tcp_frt frontend tcp_frt
mode tcp mode tcp
tcp-request content lua.hello-world everybody tcp-request content lua.hello-world everybody
.. ..
.. js:function:: core.register_converters(name, func) .. js:function:: core.register_converters(name, func)
@ -644,6 +647,7 @@ Core class
frontend http frontend http
mode http mode http
filter lua.my-filter arg1 arg2 arg3 filter lua.my-filter arg1 arg2 arg3
.. ..
:see: :js:class:`Filter` :see: :js:class:`Filter`