<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; ">Hi David,<br><div><br class="Apple-interchange-newline"><blockquote type="cite"><div>I've got a few questions about the automatically generated Python documentation.</div><div><br></div><div>1. Is this done by doxygen like the C++ documentation?</div></blockquote><div><br></div><div>No. It has traditionally been generated with pydoc. A few years back, Jan Marten Simons added generation with sphinx, which gives much better looking html pages.</div><br><blockquote type="cite"><div>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?)</div></blockquote><div><br></div><div>As far as I know, only docstrings should be gathered by pydoc or sphinx. Could you give me an example of those other comments?</div><br><blockquote type="cit!
e">
<div>3. Similarly, what determines which packages are documented or not? For example, from <a href="http://cctbx.sourceforge.net/current/python/rstbx.html">http://cctbx.sourceforge.net/current/python/rstbx.html</a>, cftbx is documented but bpcx is not. Is there at some point a manual decision about what should be documented?</div></blockquote><br></div><div>No. Some developers like to put quite a bit of comments, other don't bother. It also depends on how much in a hurry the developer is of course as documentation does nothing to help reaching a dead line.</div><div><br></div><div>Best wishes,</div><div><br></div><div>Luc</div><div><br></div></body></html>