Skip to content

Commit 0893330

Browse files
authored
Tuning docs about listing/showing kws and their docs
1 parent 29558d1 commit 0893330

File tree

1 file changed

+9
-35
lines changed

1 file changed

+9
-35
lines changed

README.rst

Lines changed: 9 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -243,50 +243,24 @@ 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-
------------------------------------------------------
246+
Listing keywords and viewing documentation
247+
------------------------------------------
248248

249-
Using the built-in Libdoc tool you can ``list`` the Keywords available in server::
249+
Using the built-in Libdoc__ tool you can list the keywords available on the server::
250250

251251
$ python -m robot.libdoc Remote::http://127.0.0.1:8270 list
252252
Count Items In Directory
253253
Stop Remote Server
254254
Strings Should Be Equal
255255

256-
If you want to ``show`` the library/resource documentation use Libdoc like this::
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::
257259

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.
260+
$ python -m robot.libdoc Remote::http://127.0.0.1:8270 MyLibrary.html
261+
/path/to/MyLibrary.html
289262
263+
__ http://robotframework.org/robotframework/#built-in-tools
290264

291265
Example
292266
-------

0 commit comments

Comments
 (0)