BASIS icon indicating copy to clipboard operation
BASIS copied to clipboard

Update Sphinx breathe source files

Open schuhschuh opened this issue 9 years ago • 4 comments
trafficstars

Issue by ahundt Friday Sep 11, 2015 at 21:26 GMT Originally opened as https://github.com/cmake-basis/legacy/issues/462


Breathe has had a lot of development since we last tried it. Perhaps we should try updating the version included and integrating it again! Probably wouldn't be too many code changes since we put it in there once already.

https://breathe.readthedocs.org/en/latest/

https://github.com/michaeljones/breathe

schuhschuh avatar Apr 17 '16 00:04 schuhschuh

it would be very cool to get rid of the iframe in docs if breathe is up to snuff now

ahundt avatar May 05 '16 12:05 ahundt

But does breathe also support an auto-generation of a complete list of all classes and such? As I understand, including the Doxygen API documentation requires one to write a .rst file with an entry for each and every class / function that should be included in the Sphinx output.

schuhschuh avatar May 05 '16 12:05 schuhschuh

Seems doxygenindex is the directive I was looking for.

schuhschuh avatar May 05 '16 12:05 schuhschuh

yeah that's the one, there is also autodoxygenindex

ahundt avatar May 05 '16 12:05 ahundt