rosdoc environment doesn't have sphinx autodoc extension installed (07/06/12)

[mirzashah]

Issue migrated from trac originally posted by "tfoote", ticket #4002

Description

This would be helpful for packages.

Change History

Changed 6 months ago by joq

Specifically, the released versions have all their modules documented, but the development version does not. E.g.:

http://ros.org/doc/fuerte/api/geodesy/html/python/geodesy.wu_point.html http://ros.org/doc/api/geodesy/html/python/geodesy.wu_point.html

[eitanme]

This doesn't seem to be an issue with rosdoc_lite. Closing.

[jack-oquin]

What makes you believe it is working?

If you follow the links above, they are still broken, i.e. the development version has no modules documented:

• http://ros.org/doc/api/geodesy/html/python/geodesy.wu_point.html

The Fuerte version is documented correctly:

• http://ros.org/doc/fuerte/api/geodesy/html/python/geodesy.wu_point.html

What can I do to fix this problem?

[jack-oquin]

How do I re-open this issue?

[eitanme]

So, for the new infrastructure, there is no "development" link... or I should say there are only development links per distro now. So, the following link is outdated:

http://ros.org/doc/api/geodesy/html/python/geodesy.wu_point.html

It refers to what the old toolchain last put in place before we switched over to the new stuff. To see the current documentation look here:

Electric: http://ros.org/doc/electric/api/geodesy/html/python/geodesy.wu_point.html Fuerte: http://ros.org/doc/fuerte/api/geodesy/html/python/geodesy.wu_point.html Groovy: http://ros.org/doc/groovy/api/geodesy/html/python/geodesy.wu_point.html

All these seem correct to me.

The old "development" link shouldn't show up anywhere on the wiki, but I suppose we could go delete the docs in the html folder just to make sure there's no confusion. Sort of up to @tfoote.

Let me know if I'm still missing something, but I think I'll leave things closed for the moment.

[jack-oquin]

When you say the "development link shouldn't show up anywhere on the wiki", I assume you are only talking about automatically generated links. What about hundreds of wiki pages with in-line links to various package interfaces? How are those supposed to work?

How are people supposed to link to interfaces for a package that is still under review, and not yet released?

Do I need to open a new issue to get these questions resolved?

[tfoote]

I think we're on a different topic here. @jack-oquin can you open a ticket on ros-infrastructure/roswiki with your issue. https://github.com/ros-infrastructure/roswiki/issues/new I think you are right that there's an issue of canonical references to wiki pages but that's separate from the sphinx issue.

[jack-oquin]

Sure will, thanks.

[eitanme]

We should, indeed, move this discussion. However, those in-line links will, indeed, point to outdated information at the moment. We can decide to pick a distro of choice (say fuerte) and just create a symlink to the documentation for "active development" to that location. That would at least be a solution that wouldn't break things rather than just removing the directory outright.

[eitanme]

Also, none of the documentation is explicitly for released packages. The documentation index for a distribution is independent of the distro files. So, to have something documented, folks simply place a rosinstall file in the appropriate distro directory and it will run, regardless of release status.

See the following folders for what this looks like: https://github.com/ros/rosdistro/tree/master/doc

Hopefully, this answers your questions.

[jack-oquin]

As Tully suggested, let's carry on this discussion in the new issue I just created:

• https://github.com/ros-infrastructure/roswiki/issues/18