[cctbxbb] Sphinx docs for CCTBX
Luc Bourhis
luc_j_bourhis at mac.com
Fri Aug 15 09:56:20 PDT 2014
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
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 2290 bytes
Desc: not available
URL: <http://phenix-online.org/pipermail/cctbxbb/attachments/20140815/760cf0d1/attachment.p7s>
More information about the cctbxbb
mailing list