OpenColorIO icon indicating copy to clipboard operation
OpenColorIO copied to clipboard

Documentation C++ tab eats whitespace in prototypes

Open jfpanisset opened this issue 2 years ago • 2 comments

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

jfpanisset avatar Nov 29 '21 19:11 jfpanisset

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

jessey-git avatar Feb 26 '22 22:02 jessey-git

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.

remia avatar Feb 27 '22 20:02 remia