search

ros-infrastructure / rosdoc_lite

A light-weight version of rosdoc that does not rely on ROS infrastructure for crawling packages.
10 stars 31 forks source link

"Edit on Github" link for appropriate sphynix pages #53

Closed davetcoleman closed 7 years ago

davetcoleman commented 9 years ago

This would be a really nice feature for encouraging ROS users to help with documentation. Similar to readthedocs we could have a plugin that provides a link at the top of sphinx pages:

screen shot 2014-12-03 at 5 54 00 pm

What are your guys thoughts on this? Is this even the correct repo for this issue? I don't know much about using Sphinx documentation but this feature is badly needed IMHO. Inline docs is how MoveIt! developers have chosen to do documentation (no more wiki) and the result has been there have been no further outside documentation contributions.

A quick google search led me to this: https://mg.pov.lt/blog/sphinx-edit-on-github.html

But I think I would have to learn a lot more about this stuff before I could figure out how to contribute a patch and am hoping someone else could.

Thoughts?

mikeferguson commented 9 years ago

+1 to coming up with a standard approach to doing this.

jack-oquin commented 9 years ago

Seems like a good idea, but what exactly should rosdoc_lite do to support it?

mikeferguson commented 9 years ago

@jack-oquin I'm not sure there is currently a way to edit the doxygen-generated page header. I assume there is a template somewhere that it gets based off, and we probably need to do something in rosdoc-lite to allow that change?

jack-oquin commented 9 years ago

I have very little idea how to do this myself, but would be happy to merge an applicable pull request.

davetcoleman commented 7 years ago

I've achieved this by copying http://docs.fetchrobotics.com/ who in turn copied ReadTheDocs's theme for Sphinx. My implementation:

https://github.com/ros-planning/moveit_tutorials/blob/8d1498956b4e92e5e9a71e61becb04ae34c27661/_themes/sphinx_rtd_theme/breadcrumbs.html#L11