Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Packages that define conf.py in standrd locations usually fail #120

Open
rkent opened this issue Apr 22, 2024 · 1 comment
Open

Packages that define conf.py in standrd locations usually fail #120

rkent opened this issue Apr 22, 2024 · 1 comment

Comments

@rkent
Copy link
Contributor

rkent commented Apr 22, 2024

I scanned rolling packages, and looked for packages with a conf.py in a standard location: doc/ or doc/source/. I found 18. Of these, 10 had serious failures (either no rosdoc2 result at all, or failure to show intended documentation:

conf.py failures:

  1. geodesy
  2. naoqi_driver
  3. cv_bridge
  4. mrpt_path_planning
  5. robot_localization
  6. ffmpeg_image_transport (readme_include fails)
  7. ffmpeg_image_transport_tools (just shows package name)
  8. quaternion_operation (just shows package name)
  9. event_camera_py (rst files not shown; failed READMR include)
  10. mrpt2

The reasons were varied, but some common reasons:

  • error in user conf.py caused abort
  • .rst files has .. include sections that referenced files not available in our wrapping

Of those who define conf.py, several would be better off with our newer rosdoc2 implementation rather than trying to roll their own. In others, the result would be better under our new documentation section rather than replacing all of the rosdoc2 output.

@rkent
Copy link
Contributor Author

rkent commented Aug 20, 2024

Just as a FYI, I've been working recently on trying to understand and overcome issues of rosdoc2 failures from a variety of sources, including this one. So this issue is rather stale, but eventually I'll propose PRs for these issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant