ros-infrastructure / rosdoc2

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

Pin to `breathe<=4.26.0` #31

Closed aprotyas closed 2 years ago

aprotyas commented 2 years ago

As discovered in https://github.com/svenevs/exhale/issues/98, older versions of breathe do not throw unresolved function name warnings and/or choke on template parameter lists.

Hence, temporarily pinning to 4.26.0.

Signed-off-by: Abrar Rahman Protyasha abrar@openrobotics.org

aprotyas commented 2 years ago

Additionally, this PR also requires pinning to a specific version of sphinx (i.e. sphinx<3.5,>=3.0). In offline discussions with @clalancette, we concluded that pinning both breathe and sphinx to specific older versions can be troublesome/impossible for users. As such, I am closing this PR here.