<div dir="ltr"><div>Well i sphinx lib is great but i guess this battle is lost, I&#39;ll write the ATP in word =(</div>
<div>one thing i don&#39;t get is my company is the only company the wants this stupid documents?</div>
<div> </div>
<div>all testing packages in python just let you write tests easily and don&#39;t care about non-programmers that want to review the tests.</div>
<div>this is fine by me but not my bosses...</div>
<div> </div>
<div>I&#39;ll like to have some input on this, what is the standard?<br><br></div>
<div class="gmail_quote">On Thu, Aug 27, 2009 at 6:57 PM, Jesse Noller <span dir="ltr">&lt;<a href="mailto:jnoller@gmail.com" target="_blank">jnoller@gmail.com</a>&gt;</span> wrote:<br>
<blockquote class="gmail_quote" style="PADDING-LEFT: 1ex; MARGIN: 0px 0px 0px 0.8ex; BORDER-LEFT: #ccc 1px solid">Beyond the look and feel, being able to mix prose/examples and<br>doctests within the RST files where you are doing autodoc style stuff<br>
is really nice.<br>
<div>
<div></div>
<div><br>On Thu, Aug 27, 2009 at 11:43 AM, Paul<br>Hildebrandt&lt;<a href="mailto:Paul.Hildebrandt@disneyanimation.com" target="_blank">Paul.Hildebrandt@disneyanimation.com</a>&gt; wrote:<br>&gt; Yoav,<br>&gt;<br>&gt; You may be interested in<br>
&gt; <a href="http://svn.sat.qc.ca/trac/miville/browser/trunk/py/docs/generate_modules.py" target="_blank">http://svn.sat.qc.ca/trac/miville/browser/trunk/py/docs/generate_modules.py</a><br>&gt; It&#39;s a little program that they put together to build the rst stubs for you.<br>
&gt;  I seem to remember reading somewhere that this feature may be included in<br>&gt; Sphinx 0.7.<br>&gt; Just as Jesse said, Sphinx was designed for writing docs not generating them<br>&gt; from code.  Generation is more of epydoc&#39;s domain.  I like the look of<br>
&gt; Sphinx better so I&#39;ve been looking for something to make Sphinx generate<br>&gt; docs and the script that I linked was the closest I found.<br>&gt;<br>&gt; Paul<br>&gt;<br>&gt; Jesse Noller wrote:<br>&gt;&gt;<br>
&gt;&gt; It&#39;s intentionally half-automatic. I generally create stubs like this:<br>&gt;&gt;<br>&gt;&gt; from test_flub.rst<br>&gt;&gt;<br>&gt;&gt; .. _shortname:<br>&gt;&gt;<br>&gt;&gt; ============================<br>
&gt;&gt; :mod:`foobar.test_flub` --- Flub tests<br>&gt;&gt; ============================<br>&gt;&gt;<br>&gt;&gt; .. automodule:: foobar.test_flub<br>&gt;&gt;    :members:<br>&gt;&gt;<br>&gt;&gt; This will extract all of the doc strings from the module - but I can<br>
&gt;&gt; then override/add-to the doc strings inline in the rst (see &quot;Options<br>&gt;&gt; and advanced usage&quot; at <a href="http://sphinx.pocoo.org/ext/autodoc.html" target="_blank">http://sphinx.pocoo.org/ext/autodoc.html</a><br>
&gt;&gt;<br>&gt;&gt; If you&#39;re looking for a true API-autodoc tool; you need to look at<br>&gt;&gt; something else. Sphinx is great for automatically doing *some* of it<br>&gt;&gt; (as above) but it&#39;s mainly made for *writing docs* - not just<br>
&gt;&gt; generating them from code.<br>&gt;&gt;<br>&gt;&gt; On Thu, Aug 27, 2009 at 12:23 AM, yoav glazner&lt;<a href="mailto:yoavglazner@gmail.com" target="_blank">yoavglazner@gmail.com</a>&gt;<br>&gt;&gt; wrote:<br>&gt;&gt;<br>
&gt;&gt;&gt;<br>&gt;&gt;&gt; I have tried to play with the auto-doc ext and it seems to be half<br>&gt;&gt;&gt; automatic, isn&#39;t there a way to automatically take unit test and make a<br>&gt;&gt;&gt; docuent/html that explains the tests?<br>
&gt;&gt;&gt;<br>&gt;&gt;&gt; On Wed, Aug 19, 2009 at 4:05 PM, Jesse Noller &lt;<a href="mailto:jnoller@gmail.com" target="_blank">jnoller@gmail.com</a>&gt; wrote:<br>&gt;&gt;&gt;<br>&gt;&gt;&gt;&gt;<br>&gt;&gt;&gt;&gt; For test specifications; I&#39;ve tended to use Sphinx (<a href="http://sphinx.pocoo.org/" target="_blank">sphinx.pocoo.org</a>)<br>
&gt;&gt;&gt;&gt; and the autodoc extension. I tend to document my tests and modules<br>&gt;&gt;&gt;&gt; pretty heavily, and so doing this allows me to extract nice-looking<br>&gt;&gt;&gt;&gt; and easy to use documentation from my tests, and accentuate as needed.<br>
&gt;&gt;&gt;&gt;<br>&gt;&gt;&gt;&gt; The nice thing with doing it this way, is that you can add further<br>&gt;&gt;&gt;&gt; examples/notes/etc on top of what is within the test code itself. It<br>&gt;&gt;&gt;&gt; also helps keep you disciplined about documentation on the tests and<br>
&gt;&gt;&gt;&gt; any supporting modules. All of the docs are in Restructured Text,<br>&gt;&gt;&gt;&gt; which is close to the perfect markup :)<br>&gt;&gt;&gt;&gt;<br>&gt;&gt;&gt;&gt; On Wed, Aug 19, 2009 at 7:07 AM, yoav glazner&lt;<a href="mailto:yoavglazner@gmail.com" target="_blank">yoavglazner@gmail.com</a>&gt;<br>
&gt;&gt;&gt;&gt; wrote:<br>&gt;&gt;&gt;&gt;<br>&gt;&gt;&gt;&gt;&gt;<br>&gt;&gt;&gt;&gt;&gt; Hi all,<br>&gt;&gt;&gt;&gt;&gt; I have a problem in my work, they want me to an &quot;ATP&quot;.<br>&gt;&gt;&gt;&gt;&gt; which means a long Word document that expalains what tests are made.<br>
&gt;&gt;&gt;&gt;&gt; no one will ever really read this document.<br>&gt;&gt;&gt;&gt;&gt; i was thinking on making the acceptance tests on top of<br>&gt;&gt;&gt;&gt;&gt; unittest/pymock/nose<br>&gt;&gt;&gt;&gt;&gt; and generate someting like the ATP,<br>
&gt;&gt;&gt;&gt;&gt; from the testFunctions docs.<br>&gt;&gt;&gt;&gt;&gt; is something like this already available?<br>&gt;&gt;&gt;&gt;&gt; Thanks a lot,<br>&gt;&gt;&gt;&gt;&gt; Yoav Glazner<br>&gt;&gt;&gt;&gt;&gt;<br>&gt;<br>
&gt;<br></div></div></blockquote></div><br></div>