fzi-forschungszentrum-informatik / catkin_doc

Tool for automatic ROS-API documentation generation
BSD 3-Clause "New" or "Revised" License
1 stars 2 forks source link

Suggestion: use sub(sub)sections instead of item lists #13

Closed fmauch closed 4 years ago

fmauch commented 4 years ago

This is a copy of https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/issues/155 raised by @gavanderhoorn

It's difficult to link to entries like topics and service documentation as they are formatted as bold, inline text.

As Github doesn't allow references to specific lines in a rendered .md doc (only through the Blame page, which doesn't render it), it would be nice if sub(sub)sections could be used instead, as links to subsections are automatically created by Github when rendering an .md.