[cctbxbb] Python documentation

David Waterman dgwaterman at gmail.com
Mon Oct 8 03:48:44 PDT 2012


I've got a few questions about the automatically generated Python

1. Is this done by doxygen like the C++ documentation?

2. What are the rules that determine whether text in source files is
included as documentation or not? Clearly docstrings are, but also some
comments do (only those at module scope?)

3. Similarly, what determines which packages are documented or not? For
example, from http://cctbx.sourceforge.net/current/python/rstbx.html, cftbx
is documented but bpcx is not. Is there at some point a manual decision
about what should be documented?


-- David
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://phenix-online.org/pipermail/cctbxbb/attachments/20121008/fc8fb5db/attachment.htm>

More information about the cctbxbb mailing list