@@ -243,50 +243,24 @@ using ``stop`` argument on the command line or by using the
243
243
``stop_remote_server `` function programmatically. Testing and stopping should
244
244
work also with other Robot Framework remote server implementations.
245
245
246
- Listing keywords and documentation available in server
247
- ------------------------------------------------------
246
+ Listing keywords and viewing documentation
247
+ ------------------------------------------
248
248
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::
250
250
251
251
$ python -m robot.libdoc Remote::http://127.0.0.1:8270 list
252
252
Count Items In Directory
253
253
Stop Remote Server
254
254
Strings Should Be Equal
255
255
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::
257
259
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
289
262
263
+ __ http://robotframework.org/robotframework/#built-in-tools
290
264
291
265
Example
292
266
-------
0 commit comments