Skip to content

Added info about remote keywords and documentation #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 12, 2018
Merged

Added info about remote keywords and documentation #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29558d1
Added info about remote keywords and documentation
brunogoncalooliveira Apr 4, 2018
0893330
Tuning docs about listing/showing kws and their docs
pekkaklarck Apr 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,25 @@ using ``stop`` argument on the command line or by using the
``stop_remote_server`` function programmatically. Testing and stopping should
work also with other Robot Framework remote server implementations.

Listing keywords and viewing documentation
------------------------------------------

Using the built-in Libdoc__ tool you can list the keywords available on the server::

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

It is also possible to show the documentation on the command line by using
argument ``show``. HTML documentation can be created by providing name of
an output file::

$ python -m robot.libdoc Remote::http://127.0.0.1:8270 MyLibrary.html
/path/to/MyLibrary.html

__ http://robotframework.org/robotframework/#built-in-tools

Example
-------

Expand Down