this:
https://github.com/michaeljones/breathe/tree/master
Is referenced in the sphinx FAQ, and seems pretty stable. Thoughts?
Oli
On Fri, Aug 15, 2014 at 9:56 AM, Luc Bourhis
Hi guys,
my 2p about that if you don't mind.
I think that ideally, we should try to find a way to pass the doxygen documentation into Sphinx.
If it is too much work to figure out, then of your 3 variants, (3) would be my preferred choice because it puts the documentation as close to the code that is actually documented, i.e. the wrapped C++ code. If the code has already been structured as your (1), this is most likely because the Python function does more than the C++ function, and the documentation should be in the overriden Python function then. Your variant (2) is just too ugly to my taste.
Best wishes,
Luc
_______________________________________________ cctbxbb mailing list [email protected] http://phenix-online.org/mailman/listinfo/cctbxbb
-- Dr. Oliver B. Zeldin Brunger Group Stanford University