Skip to content

Commit 29558d1

Browse files
Added info about remote keywords and documentation
1 parent 7ce9b3c commit 29558d1

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,51 @@ using ``stop`` argument on the command line or by using the
243243
``stop_remote_server`` function programmatically. Testing and stopping should
244244
work also with other Robot Framework remote server implementations.
245245

246+
Listing keywords and documentation available in server
247+
------------------------------------------------------
248+
249+
Using the built-in Libdoc tool you can ``list`` the Keywords available in server::
250+
251+
$ python -m robot.libdoc Remote::http://127.0.0.1:8270 list
252+
Count Items In Directory
253+
Stop Remote Server
254+
Strings Should Be Equal
255+
256+
If you want to ``show`` the library/resource documentation use Libdoc like this::
257+
258+
$ python -m robot.libdoc Remote::http://127.0.0.1:8270 show
259+
Remote
260+
======
261+
Scope: test suite
262+
Named arguments: supported
263+
264+
Example library to be used with Robot Framework's remote server.
265+
266+
This documentation is visible in docs generated by `Libdoc`.
267+
268+
Count Items In Directory
269+
------------------------
270+
Arguments: [path]
271+
272+
Returns the number of items in the directory specified by `path`.
273+
274+
Stop Remote Server
275+
------------------
276+
Arguments: []
277+
278+
Stop the remote server unless stopping is disabled.
279+
280+
Return ``True/False`` depending was server stopped or not.
281+
282+
Strings Should Be Equal
283+
-----------------------
284+
Arguments: [str1, str2]
285+
286+
287+
For more information run `python -m robot.libdoc --help` and for even more
288+
details see the User Guide.
289+
290+
246291
Example
247292
-------
248293

0 commit comments

Comments
 (0)