<div dir="ltr"><div>Well i sphinx lib is great but i guess this battle is lost, I'll write the ATP in word =(</div>
<div>one thing i don'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'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'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"><<a href="mailto:jnoller@gmail.com" target="_blank">jnoller@gmail.com</a>></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<<a href="mailto:Paul.Hildebrandt@disneyanimation.com" target="_blank">Paul.Hildebrandt@disneyanimation.com</a>> wrote:<br>> Yoav,<br>><br>> You may be interested in<br>
> <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>> It's a little program that they put together to build the rst stubs for you.<br>
> I seem to remember reading somewhere that this feature may be included in<br>> Sphinx 0.7.<br>> Just as Jesse said, Sphinx was designed for writing docs not generating them<br>> from code. Generation is more of epydoc's domain. I like the look of<br>
> Sphinx better so I've been looking for something to make Sphinx generate<br>> docs and the script that I linked was the closest I found.<br>><br>> Paul<br>><br>> Jesse Noller wrote:<br>>><br>
>> It's intentionally half-automatic. I generally create stubs like this:<br>>><br>>> from test_flub.rst<br>>><br>>> .. _shortname:<br>>><br>>> ============================<br>
>> :mod:`foobar.test_flub` --- Flub tests<br>>> ============================<br>>><br>>> .. automodule:: foobar.test_flub<br>>> :members:<br>>><br>>> This will extract all of the doc strings from the module - but I can<br>
>> then override/add-to the doc strings inline in the rst (see "Options<br>>> and advanced usage" at <a href="http://sphinx.pocoo.org/ext/autodoc.html" target="_blank">http://sphinx.pocoo.org/ext/autodoc.html</a><br>
>><br>>> If you're looking for a true API-autodoc tool; you need to look at<br>>> something else. Sphinx is great for automatically doing *some* of it<br>>> (as above) but it's mainly made for *writing docs* - not just<br>
>> generating them from code.<br>>><br>>> On Thu, Aug 27, 2009 at 12:23 AM, yoav glazner<<a href="mailto:yoavglazner@gmail.com" target="_blank">yoavglazner@gmail.com</a>><br>>> wrote:<br>>><br>
>>><br>>>> I have tried to play with the auto-doc ext and it seems to be half<br>>>> automatic, isn't there a way to automatically take unit test and make a<br>>>> docuent/html that explains the tests?<br>
>>><br>>>> On Wed, Aug 19, 2009 at 4:05 PM, Jesse Noller <<a href="mailto:jnoller@gmail.com" target="_blank">jnoller@gmail.com</a>> wrote:<br>>>><br>>>>><br>>>>> For test specifications; I've tended to use Sphinx (<a href="http://sphinx.pocoo.org/" target="_blank">sphinx.pocoo.org</a>)<br>
>>>> and the autodoc extension. I tend to document my tests and modules<br>>>>> pretty heavily, and so doing this allows me to extract nice-looking<br>>>>> and easy to use documentation from my tests, and accentuate as needed.<br>
>>>><br>>>>> The nice thing with doing it this way, is that you can add further<br>>>>> examples/notes/etc on top of what is within the test code itself. It<br>>>>> also helps keep you disciplined about documentation on the tests and<br>
>>>> any supporting modules. All of the docs are in Restructured Text,<br>>>>> which is close to the perfect markup :)<br>>>>><br>>>>> On Wed, Aug 19, 2009 at 7:07 AM, yoav glazner<<a href="mailto:yoavglazner@gmail.com" target="_blank">yoavglazner@gmail.com</a>><br>
>>>> wrote:<br>>>>><br>>>>>><br>>>>>> Hi all,<br>>>>>> I have a problem in my work, they want me to an "ATP".<br>>>>>> which means a long Word document that expalains what tests are made.<br>
>>>>> no one will ever really read this document.<br>>>>>> i was thinking on making the acceptance tests on top of<br>>>>>> unittest/pymock/nose<br>>>>>> and generate someting like the ATP,<br>
>>>>> from the testFunctions docs.<br>>>>>> is something like this already available?<br>>>>>> Thanks a lot,<br>>>>>> Yoav Glazner<br>>>>>><br>><br>
><br></div></div></blockquote></div><br></div>