reStructuredText in Python functions not displaying in Robot Framework hub
My sample Python module for robotframework looks like this.
ROBOT_LIBRARY_DOC_FORMAT = 'reST'
def foo (a, b):
"""Produces bar.
:param ``a``: this is a.
:param ``b``: this is b.
"""
But then using the rfhub Web app to view in browser, param a and b are smashed onto one line, and it looks like it is coming out as the wiki style. Is reST supported in rfhub? See below screen shot.
user@ubuntu-01:~$ python -m rfhub ./test-project/testcases
tornado web server running on http://127.0.0.1:7070
rfhub_example_helloworld
python robotframework
add a comment |
My sample Python module for robotframework looks like this.
ROBOT_LIBRARY_DOC_FORMAT = 'reST'
def foo (a, b):
"""Produces bar.
:param ``a``: this is a.
:param ``b``: this is b.
"""
But then using the rfhub Web app to view in browser, param a and b are smashed onto one line, and it looks like it is coming out as the wiki style. Is reST supported in rfhub? See below screen shot.
user@ubuntu-01:~$ python -m rfhub ./test-project/testcases
tornado web server running on http://127.0.0.1:7070
rfhub_example_helloworld
python robotframework
add a comment |
My sample Python module for robotframework looks like this.
ROBOT_LIBRARY_DOC_FORMAT = 'reST'
def foo (a, b):
"""Produces bar.
:param ``a``: this is a.
:param ``b``: this is b.
"""
But then using the rfhub Web app to view in browser, param a and b are smashed onto one line, and it looks like it is coming out as the wiki style. Is reST supported in rfhub? See below screen shot.
user@ubuntu-01:~$ python -m rfhub ./test-project/testcases
tornado web server running on http://127.0.0.1:7070
rfhub_example_helloworld
python robotframework
My sample Python module for robotframework looks like this.
ROBOT_LIBRARY_DOC_FORMAT = 'reST'
def foo (a, b):
"""Produces bar.
:param ``a``: this is a.
:param ``b``: this is b.
"""
But then using the rfhub Web app to view in browser, param a and b are smashed onto one line, and it looks like it is coming out as the wiki style. Is reST supported in rfhub? See below screen shot.
user@ubuntu-01:~$ python -m rfhub ./test-project/testcases
tornado web server running on http://127.0.0.1:7070
rfhub_example_helloworld
python robotframework
python robotframework
edited Nov 25 '18 at 0:27
learning2learn
asked Nov 22 '18 at 1:48
learning2learnlearning2learn
3624
3624
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
My suspicion at this point is that it is simply not supported by robotframework hub.
To doublecheck it, I did this:
user@ubuntu-01:~$ python -m robot.libdoc ./test-project/testcases/HelloWorld.py testdoc.html
where the HelloWorld.py was:
ROBOT_LIBRARY_DOC_FORMAT = 'reST'
def foo(a, b):
"""Produces bar.
:param ``a``: this is a.
:param ``b``: this is b.
"""
return "bar"
def foo2(a, b):
"""Also produces bar.
:a: this is a.
:b: this is b.
"""
return "bar"
Above produces this output in my browser:
libdoc_output_restructuredtext
Which shows the fields are broken onto separate lines as I expect for reStructuredText. If I comment out the ROBOT_LIBRARY_DOC_FORMAT line, that no longer works. I'll add a similar screenshot to my original question showing the issue in robotframework hub.
add a comment |
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53422820%2frestructuredtext-in-python-functions-not-displaying-in-robot-framework-hub%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
My suspicion at this point is that it is simply not supported by robotframework hub.
To doublecheck it, I did this:
user@ubuntu-01:~$ python -m robot.libdoc ./test-project/testcases/HelloWorld.py testdoc.html
where the HelloWorld.py was:
ROBOT_LIBRARY_DOC_FORMAT = 'reST'
def foo(a, b):
"""Produces bar.
:param ``a``: this is a.
:param ``b``: this is b.
"""
return "bar"
def foo2(a, b):
"""Also produces bar.
:a: this is a.
:b: this is b.
"""
return "bar"
Above produces this output in my browser:
libdoc_output_restructuredtext
Which shows the fields are broken onto separate lines as I expect for reStructuredText. If I comment out the ROBOT_LIBRARY_DOC_FORMAT line, that no longer works. I'll add a similar screenshot to my original question showing the issue in robotframework hub.
add a comment |
My suspicion at this point is that it is simply not supported by robotframework hub.
To doublecheck it, I did this:
user@ubuntu-01:~$ python -m robot.libdoc ./test-project/testcases/HelloWorld.py testdoc.html
where the HelloWorld.py was:
ROBOT_LIBRARY_DOC_FORMAT = 'reST'
def foo(a, b):
"""Produces bar.
:param ``a``: this is a.
:param ``b``: this is b.
"""
return "bar"
def foo2(a, b):
"""Also produces bar.
:a: this is a.
:b: this is b.
"""
return "bar"
Above produces this output in my browser:
libdoc_output_restructuredtext
Which shows the fields are broken onto separate lines as I expect for reStructuredText. If I comment out the ROBOT_LIBRARY_DOC_FORMAT line, that no longer works. I'll add a similar screenshot to my original question showing the issue in robotframework hub.
add a comment |
My suspicion at this point is that it is simply not supported by robotframework hub.
To doublecheck it, I did this:
user@ubuntu-01:~$ python -m robot.libdoc ./test-project/testcases/HelloWorld.py testdoc.html
where the HelloWorld.py was:
ROBOT_LIBRARY_DOC_FORMAT = 'reST'
def foo(a, b):
"""Produces bar.
:param ``a``: this is a.
:param ``b``: this is b.
"""
return "bar"
def foo2(a, b):
"""Also produces bar.
:a: this is a.
:b: this is b.
"""
return "bar"
Above produces this output in my browser:
libdoc_output_restructuredtext
Which shows the fields are broken onto separate lines as I expect for reStructuredText. If I comment out the ROBOT_LIBRARY_DOC_FORMAT line, that no longer works. I'll add a similar screenshot to my original question showing the issue in robotframework hub.
My suspicion at this point is that it is simply not supported by robotframework hub.
To doublecheck it, I did this:
user@ubuntu-01:~$ python -m robot.libdoc ./test-project/testcases/HelloWorld.py testdoc.html
where the HelloWorld.py was:
ROBOT_LIBRARY_DOC_FORMAT = 'reST'
def foo(a, b):
"""Produces bar.
:param ``a``: this is a.
:param ``b``: this is b.
"""
return "bar"
def foo2(a, b):
"""Also produces bar.
:a: this is a.
:b: this is b.
"""
return "bar"
Above produces this output in my browser:
libdoc_output_restructuredtext
Which shows the fields are broken onto separate lines as I expect for reStructuredText. If I comment out the ROBOT_LIBRARY_DOC_FORMAT line, that no longer works. I'll add a similar screenshot to my original question showing the issue in robotframework hub.
answered Nov 25 '18 at 0:15
learning2learnlearning2learn
3624
3624
add a comment |
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53422820%2frestructuredtext-in-python-functions-not-displaying-in-robot-framework-hub%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown