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

Adding autodoc to sphinx config. #55

Closed jbohren closed 9 years ago

jbohren commented 9 years ago

Is this all that's needed to actually have documentation for things like this?

http://docs.ros.org/hydro/api/tf_conversions/html/python/

Notice the automodule directive here: http://docs.ros.org/hydro/api/tf_conversions/html/python/_sources/index.txt

jbohren commented 9 years ago

To answer my own question: yes

This does enable sphinx documentation to use automodules.

jack-oquin commented 9 years ago

Thanks for the patch, Jon. Looks good to me.

jbohren commented 9 years ago

Does rosdoc_lite need to get released before this affects the stuff on docs.ros.org?

jack-oquin commented 9 years ago

No, but I plan to release it anyway, at least to Indigo. It needs to be released for it to work out-of-the-box when running on your own development system.

Do you need or want it on Hydro?

jbohren commented 9 years ago

Do you need or want it on Hydro?

Yeah, that would be great if it's not too much trouble.

jack-oquin commented 9 years ago

No trouble.

I normally would not make changes (except bug fixes) in a release that old, but since the build farm always picks up the latest version, it seems reasonable to keep the Hydro release in sync.

jbohren commented 9 years ago

@jack-oquin Any idea why the automodule stuff still isn't working? It worked when I ran it on my local machine.

jack-oquin commented 9 years ago

Perhaps the build farm does not have some packages installed that you do?

If so, and we can figure out what they are, we could maybe add them with <doc_depend>.