[FEATURE REQUEST] Link to a source code from OpenImageIO documentation

[ssh4net]

Too often, documentation is not enough to understand how some API functions are working.
For example, Colour-Science Python library usually provides a link to a source code where possible to check how it works under the hood. (for example https://colour.readthedocs.io/en/master/generated/colour.CHROMATIC_ADAPTATION_METHODS.html )

OpenImageIO can also win from a similar approach. Like in case when user wants to check if there is a additional optimisation in function code, or not all input parameters are documented.

[lgritz]

That's interesting. Does anybody have a good idea about how to achieve this in a fairly automatic way for our documentation system?

[wgergely]

If the docs are built with sphinx adding 'sphinx.ext.viewcode' to extensions in src/doc/conf.py should do the trick? Shall I make a pull request?

[lgritz]

Yes, please!

We build docs with Sphinx, using the Breathe plugin which takes Doxygen-generated XML that extracts API documentation from the C++ headers.

[aarondemolder]

Came across this and saw this didn't happen, so made a PR - hope that's alright 😄

[aarondemolder]

If the docs are built with sphinx adding 'sphinx.ext.viewcode' to extensions in src/doc/conf.py should do the trick? Shall I make a pull request?

Unfortunately it wasn't quite so simple and will need some more attention - I found some more discussion on similar here: breathe-doc/breathe#388