Skip to content

Commit 5324821

Browse files
authored
Merge pull request #49 from brunogoncalooliveira/patch-1
Added info about remote keywords and documentation
2 parents 7ce9b3c + 0893330 commit 5324821

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.rst

+19
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,25 @@ 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 viewing documentation
247+
------------------------------------------
248+
249+
Using the built-in Libdoc__ tool you can list the keywords available on the 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+
It is also possible to show the documentation on the command line by using
257+
argument ``show``. HTML documentation can be created by providing name of
258+
an output file::
259+
260+
$ python -m robot.libdoc Remote::http://127.0.0.1:8270 MyLibrary.html
261+
/path/to/MyLibrary.html
262+
263+
__ http://robotframework.org/robotframework/#built-in-tools
264+
246265
Example
247266
-------
248267

0 commit comments

Comments
 (0)