search

AcademySoftwareFoundation / OpenColorIO

A color management framework for visual effects and animation.
https://opencolorio.org
BSD 3-Clause "New" or "Revised" License
1.76k stars 435 forks source link

Documentation C++ tab eats whitespace in prototypes #1537

Open jfpanisset opened 2 years ago

jfpanisset commented 2 years ago

When looking at a documentation page such as:

https://opencolorio.readthedocs.io/en/latest/api/colorspace.html

If you switch from the default Python to the C++ tab, function prototypes have most of the whitespace stripped away, for instance:

constchar*getName()constnoexcept

I can reproduce this on both Chrome and Firefox on macOS (current versions).

ocio_prototypes_no_spaces

jessey-git commented 2 years ago

Unsure how to bump this task up to get on the radar but it is indeed quite annoying.

remia commented 2 years ago

This seems to be an old issue of sphinx, as discussed in https://github.com/michaeljones/breathe/issues/655, https://github.com/readthedocs/sphinx_rtd_theme/issues/694 and probably many others.

From what I read, it should have been fixed in sphinx 4, but for some reasons our RTD builds seems to use outdated sphinx 2 versions when I looked at the log. I never used RTD and I didn't saw any configuration file at OCIO root, are we using RTD admin panel to configure it? The recommended way seems to be the configuration file now.