ros-infrastructure / rosdoc2

Command-line tool for generating documentation for ROS 2 packages.
Apache License 2.0
29 stars 9 forks source link

Broken with Sphinx 7.3 #106

Closed tfoote closed 2 months ago

tfoote commented 2 months ago

Between the CI of #99 and test build on merge the CI appears to have broken

Passing:

https://github.com/ros-infrastructure/rosdoc2/actions/runs/8699265272/job/23857580345

Sphinx==7.2.6

Broken:

https://github.com/ros-infrastructure/rosdoc2/actions/runs/8726584290/job/23942199944

Sphinx==7.3.5

7.3 has come out in the last 2 days with several patch releases:

https://pypi.org/project/Sphinx/#history

image

The core error:

Exception occurred:
  File "/usr/local/lib/python3.10/dist-packages/breathe/directives/function.py", line 161, in DoxygenFunctionDirective
    def _parse_args(self, function_description: str) -> Optional[cpp.ASTParametersQualifiers]:
AttributeError: module 'sphinx.domains.cpp' has no attribute 'ASTParametersQualifiers'
The full traceback has been saved in /tmp/sphinx-err-3wec0qsg.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
tfoote commented 2 months ago

There's a ticket upstream with a comment saying that Breath is broken too: https://github.com/sphinx-doc/sphinx/issues/12295#issuecomment-2061206831

tfoote commented 2 months ago

Breath Ticket: https://github.com/breathe-doc/breathe/issues/981

tfoote commented 2 months ago

Looks like this is patched in main as of an hour ago: https://github.com/sphinx-doc/sphinx/pull/12298 hopefully this will come out shortly. And we can wait a bit for the fix.

rkent commented 2 months ago

Working now with Sphinx 7.3.6 released.

tfoote commented 2 months ago

Great, I'm retriggering https://github.com/ros-infrastructure/rosdoc2/actions/runs/8726584290 to validate. And it passed!