From 29558d121fdd0a51789652941e690d326d7b7ac8 Mon Sep 17 00:00:00 2001 From: brunogoncalooliveira Date: Wed, 4 Apr 2018 23:48:22 +0100 Subject: [PATCH 1/2] Added info about remote keywords and documentation --- README.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/README.rst b/README.rst index 0b52db3..e855948 100644 --- a/README.rst +++ b/README.rst @@ -243,6 +243,51 @@ 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 documentation available in server +------------------------------------------------------ + +Using the built-in Libdoc tool you can ``list`` the Keywords available in server:: + + $ python -m robot.libdoc Remote::http://127.0.0.1:8270 list + Count Items In Directory + Stop Remote Server + Strings Should Be Equal + +If you want to ``show`` the library/resource documentation use Libdoc like this:: + + $ python -m robot.libdoc Remote::http://127.0.0.1:8270 show + Remote + ====== + Scope: test suite + Named arguments: supported + + Example library to be used with Robot Framework's remote server. + + This documentation is visible in docs generated by `Libdoc`. + + Count Items In Directory + ------------------------ + Arguments: [path] + + Returns the number of items in the directory specified by `path`. + + Stop Remote Server + ------------------ + Arguments: [] + + Stop the remote server unless stopping is disabled. + + Return ``True/False`` depending was server stopped or not. + + Strings Should Be Equal + ----------------------- + Arguments: [str1, str2] + + +For more information run `python -m robot.libdoc --help` and for even more +details see the User Guide. + + Example ------- From 0893330cfbdc2455281dd171d4d16ef3aa0e7c71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pekka=20Kl=C3=A4rck?= Date: Thu, 12 Apr 2018 14:40:55 +0300 Subject: [PATCH 2/2] Tuning docs about listing/showing kws and their docs --- README.rst | 44 +++++++++----------------------------------- 1 file changed, 9 insertions(+), 35 deletions(-) diff --git a/README.rst b/README.rst index e855948..476f0ed 100644 --- a/README.rst +++ b/README.rst @@ -243,50 +243,24 @@ 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 documentation available in server ------------------------------------------------------- +Listing keywords and viewing documentation +------------------------------------------ -Using the built-in Libdoc tool you can ``list`` the Keywords available in server:: +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 -If you want to ``show`` the library/resource documentation use Libdoc like this:: +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 show - Remote - ====== - Scope: test suite - Named arguments: supported - - Example library to be used with Robot Framework's remote server. - - This documentation is visible in docs generated by `Libdoc`. - - Count Items In Directory - ------------------------ - Arguments: [path] - - Returns the number of items in the directory specified by `path`. - - Stop Remote Server - ------------------ - Arguments: [] - - Stop the remote server unless stopping is disabled. - - Return ``True/False`` depending was server stopped or not. - - Strings Should Be Equal - ----------------------- - Arguments: [str1, str2] - - -For more information run `python -m robot.libdoc --help` and for even more -details see the User Guide. + $ 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 -------