search

wolverine2k / crunchy

Automatically exported from code.google.com/p/crunchy
0 stars 0 forks source link

automatic documentation testing #90

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago 
There appears to be a need for a tool that would allow automatic testing of
code sample within documentation (say for a book writer).  See the comments
on
http://pyside.blogspot.com/2008/01/what-do-you-look-for-in-documentation.html
for an example.

This should be easily done within Crunchy, for either html files or reST
ones.  What we need is to combine the code from two fields (a setup one,
and the actual code sample), something like we do for the doctest plugin,
and compare the output with some expected output.

I'm setting the priority to High as having this would likely give a lot
more visibility to Crunchy.

Original issue reported on code.google.com by andre.ro...@gmail.com on 22 Jan 2008 at 1:03

GoogleCodeExporter commented 8 years ago 
Done for html files.  Adaptation for rst files left to be done.

Original comment by andre.ro...@gmail.com on 1 Feb 2008 at 11:38

GoogleCodeExporter commented 8 years ago 
I'm closing the issue for now. The basic infrastructure is in place.  Until 
there is
an actual demand for this, there's little point in working further on it.

Original comment by andre.ro...@gmail.com on 2 Feb 2008 at 7:35

GoogleCodeExporter commented 8 years ago 
Reopening this issue as the latest release of sphinx contains relevant syntax 
for rst
directives.  It might be useful to be ahead of demand on this one to give even 
more
visibility to Crunchy.

See http://sphinx.pocoo.org/ext/doctest.html

Original comment by andre.ro...@gmail.com on 21 Mar 2008 at 7:59

GoogleCodeExporter commented 8 years ago 
There is a need to document this better under "Miscellaneous" (replacement of
"Tests"), but otherwise no need to have any further progress until beyond 1.0.

I am labeling it as for Release 1.0, only for the documentation aspect; as soon 
as it
is done, it can be relabeled to beyond 1.0

Original comment by andre.ro...@gmail.com on 31 May 2008 at 1:07

GoogleCodeExporter commented 8 years ago 
Changed label; ready as is for 1.0.

Original comment by andre.ro...@gmail.com on 8 Jun 2008 at 8:39

GoogleCodeExporter commented 8 years ago 
Changing the label again; need to include in "experimental feature" section, to 
give
it some visibility.

Original comment by andre.ro...@gmail.com on 6 Oct 2008 at 1:37

GoogleCodeExporter commented 8 years ago 
No further changes needed for 1.0 final.

Original comment by andre.ro...@gmail.com on 5 Dec 2008 at 2:28