[TIP] - ATP problem
jnoller at gmail.com
Thu Aug 27 06:31:33 PDT 2009
It's intentionally half-automatic. I generally create stubs like this:
:mod:`foobar.test_flub` --- Flub tests
.. automodule:: foobar.test_flub
This will extract all of the doc strings from the module - but I can
then override/add-to the doc strings inline in the rst (see "Options
and advanced usage" at http://sphinx.pocoo.org/ext/autodoc.html
If you're looking for a true API-autodoc tool; you need to look at
something else. Sphinx is great for automatically doing *some* of it
(as above) but it's mainly made for *writing docs* - not just
generating them from code.
On Thu, Aug 27, 2009 at 12:23 AM, yoav glazner<yoavglazner at gmail.com> wrote:
> I have tried to play with the auto-doc ext and it seems to be half
> automatic, isn't there a way to automatically take unit test and make a
> docuent/html that explains the tests?
> On Wed, Aug 19, 2009 at 4:05 PM, Jesse Noller <jnoller at gmail.com> wrote:
>> For test specifications; I've tended to use Sphinx (sphinx.pocoo.org)
>> and the autodoc extension. I tend to document my tests and modules
>> pretty heavily, and so doing this allows me to extract nice-looking
>> and easy to use documentation from my tests, and accentuate as needed.
>> The nice thing with doing it this way, is that you can add further
>> examples/notes/etc on top of what is within the test code itself. It
>> also helps keep you disciplined about documentation on the tests and
>> any supporting modules. All of the docs are in Restructured Text,
>> which is close to the perfect markup :)
>> On Wed, Aug 19, 2009 at 7:07 AM, yoav glazner<yoavglazner at gmail.com>
>> > Hi all,
>> > I have a problem in my work, they want me to an "ATP".
>> > which means a long Word document that expalains what tests are made.
>> > no one will ever really read this document.
>> > i was thinking on making the acceptance tests on top of
>> > unittest/pymock/nose
>> > and generate someting like the ATP,
>> > from the testFunctions docs.
>> > is something like this already available?
>> > Thanks a lot,
>> > Yoav Glazner
>> > _______________________________________________
>> > testing-in-python mailing list
>> > testing-in-python at lists.idyll.org
>> > http://lists.idyll.org/listinfo/testing-in-python
> testing-in-python mailing list
> testing-in-python at lists.idyll.org
More information about the testing-in-python