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

Confusing usage of sphinx_sourcedir in rosdoc2.yaml #92

Open
rkent opened this issue Apr 5, 2024 · 0 comments
Open

Confusing usage of sphinx_sourcedir in rosdoc2.yaml #92

rkent opened this issue Apr 5, 2024 · 0 comments

Comments

@rkent
Copy link
Contributor

rkent commented Apr 5, 2024

Point 1: confusing meaning of sphinx_sourcedir

I find six packages in iron currently defining sphinx_sourcedir in rosdoc2.yaml:

rclpy, tf2_ros_py, ffmpeg_image_transport, fuse_doc, ffmpeg_image_transport_tools, event_camera_py

Of these six, three are using it just to point to the default doc/ directory where they have customized index.rst and conf.py:

ffmpeg_image_transport, ffmpeg_image_transport_tools, event_camera_py

It needs to be clearer that the point of this is to point to a non-standard location like docs/source and not to mark that you have customized index.rst and conf.py

Point 2: You should be able to use it without customizing index.rst

Currently, if you specify sphinx_sourcedir but have NOT customized conf.py, it will generate an error. So the program itself seems to have two uses in mind. We already search for conf.py and index.rst and use defaults if missing, we should also do that if the sphinx project is redirected to a different directory.

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