Sample python code that displays as expected by robot.libdoc:
ROBOT_LIBRARY_DOC_FORMAT = 'reST'
def foo (a, b):
"""Produces bar.
:param ``a``: this is a.
:param ``b``: this is b.
"""
Invoke hub:
user@ubuntu-01:~$ python -m rfhub ./test-project/testcases
tornado web server running on http://127.0.0.1:7070
Looks like this:
Note the "param a" and "param b" fields are smashed together on one line, versus wit the libdoc, where the fields are displayed on separate lines in the html. I could not find remarks in the documentation whether reStructuredText was explicitly supported, but I assumed the use of docutils by robotframework-hub should make it so.
Sample python code that displays as expected by robot.libdoc:
Invoke hub:
Looks like this:
Note the "param a" and "param b" fields are smashed together on one line, versus wit the libdoc, where the fields are displayed on separate lines in the html. I could not find remarks in the documentation whether reStructuredText was explicitly supported, but I assumed the use of docutils by robotframework-hub should make it so.
Thanks for the neat tool by the way.