Converted Markdown files to reStructuredText #5
Conversation
There was a problem hiding this comment.
@apojomovsky Overall looks good. I wonder though if free URLs are hyperlinked or not after going through Sphinx. Worth checking.
Also, I see that many code-blocks lack a language assignment. That was the case before as well, so fixing that could be deferred.
|
|
||
| Parameters in ROS 2 are based on services, and as such have a similar profile. | ||
| The difference is that parameters use a much larger queue depth so that requests do not get lost when, for example, the parameter client is unable to reach the parameter service server. | ||
|
|
||
| - System default | ||
| * | ||
| System default |
There was a problem hiding this comment.
@apojomovsky this one and immediately above, spurious newline after *?
There was a problem hiding this comment.
Yes, exactly. They don't seem to have effect in the rendered document though, but I just fixed them.
Ament-Tutorial.rst
Outdated
|
|
||
| ament build . --force-cmake-configure --cmake-args -DCMAKE_BUILD_TYPE=Debug -- --ament-cmake-args -DCMAKE_BUILD_TYPE=Release | ||
|
|
||
| :raw-html-m2r:`<br>` |
There was a problem hiding this comment.
@apojomovsky is this really necessary?
There was a problem hiding this comment.
Nope, thanks for pointing it out! Just removed it.
Build-Cop-and-Build-Farmer-Guide.rst
Outdated
| * https://docs.google.com/a/osrfoundation.org/spreadsheets/d/1OSwqbE3qPF8v3HSMr8JOaJ6r4QOiQFk6pwgaudXVE-4/edit?usp=sharing | ||
|
|
||
| * For machines hosted at OSRF, you'll need to be on the OSRF network or have a VPN connection. | ||
| * For machines which require :raw-html-m2r:`<ssh keys>` ask on ros@osrfoundation.org for your public keys to be added. |
There was a problem hiding this comment.
@apojomovsky here and immediately below, that raw-html role looks like the conversion tool choked at those angle brackets. I'd remove them if possible.
There was a problem hiding this comment.
Hm, yes, it seems the converter identified it as a piece of html, not necessary though. Just removed them, thanks!
apojomovsky
force-pushed
the
apojomovsky/convert_md_to_rst
branch
from
da030ef
to
19e84f6
Compare
|
Thanks for the review @hidmic , just finished addressing your comments and to fix some other minor things here and there. |
apojomovsky
force-pushed
the
apojomovsky/convert_md_to_rst
branch
from
19e84f6
to
8bb4974
Compare
|
Ok, I think this one's ready. |
In this PR
mdtorst.