How does rosdoc_lite resolve Sphinx autodoc strings for Python? [closed]

asked 2013-07-27 06:16:43 -0500

joq gravatar image

updated 2013-07-27 06:25:42 -0500

I am trying to figure out why Sphinx autodoc for some of my Python packages does not get expanded on the wiki.

Autodoc requires the modules to be accessible via the Python sys.path. For rosbuild, that meant it was necessary to add this near the top of the

import roslib

With catkin, that is no longer necessary, at least when running rosdoc_lite locally:

$ rosdoc_lite -o ~/doc/unique_id .

It works even with an unbuilt checkout of the source repository.

But, on Jenkins it fails:

Retrieve the ROS build environment by sourcing /home/rosbuild/hudson/workspace/doc-hydro-unique_identifier/doc_stacks/2013-07-26_06-55-19.493830/build_repo/Making output directory...
/home/rosbuild/hudson/workspace/doc-hydro-unique_identifier/doc_stacks/2013-07-26_06-55-19.493830/unique_identifier/unique_id/unique_id.rst:4: WARNING: autodoc can't import/find module 'unique_id', it reported error: "No module named unique_id", please check your spelling and sys.path
WARNING: html_static_path entry '/home/rosbuild/hudson/workspace/doc-hydro-unique_identifier/doc_stacks/2013-07-26_06-55-19.493830/unique_identifier/unique_id/_static' does not exist

What is happening differently?

Update: it looks like some of the failing packages are working correctly on Groovy, but failing on Hydro.

edit retag flag offensive reopen merge delete

Closed for the following reason question is not relevant or outdated by tfoote
close date 2016-04-27 01:54:08.539612