Maybe they could be kept as standalone runnable samples and placed in a separate area of the documentation. They could then be browsed as a group and the user can select the one they want to look at from there, and they can also be linked to from the specific class documentation page for the widget that they demo.
···
On 3/13/12 10:56 AM, Chris Barker wrote:
On Mon, Mar 12, 2012 at 3:42 PM, Robin Dunn<robin@alldunn.com> wrote:
On 3/12/12 3:28 PM, Andrea Gavana wrote:
I would like to ask the community to try and contribute snippets of
code for methods/classes/functions which do not currently have a
wxPython example,
To help get an idea of what Andrea is
asking for the existing snippets can be seen at the following location in
the source repository. They are just simple bits of code that get merged in
to the docs when they are generated.
I've got quite a few (~100 now!) small demo samples. For the most
part, the each:
are a complete app (al la "making sample apps")
demonstrate/test a single widget or concept.
But they are a fair bit larger than the snippets we're talking about here.
I have written them over the years from a combination of trying
out/testing stuff for myself, and answering questions for folks on the
wxPython list.
I've been looking for a while for a good place to put them, so others
can make use of them, and also test and improve them -- they certainly
need testing/updated with more recent wxPython (modification dates
back to 2008, and some may well be older)
So: should I see if I can figure out a way to re-organise these so
they could get built into the Sphinx docs? That would be pretty cool.
+1. If Chris can somehow "rename" his Python scripts to make my life
easier in linking them against a specific widget, it would be even
better. And it would be perfect if the samples had a few lines of
comment at the top so that I could extract those comments to make a
header description of the sample and then include the code as a Sphinx
Python output
On Mon, Mar 12, 2012 at 3:42 PM, Robin Dunn<robin@alldunn.com> wrote:
On 3/12/12 3:28 PM, Andrea Gavana wrote:
I would like to ask the community to try and contribute snippets of
code for methods/classes/functions which do not currently have a
wxPython example,
To help get an idea of what Andrea is
asking for the existing snippets can be seen at the following location in
the source repository. They are just simple bits of code that get merged
in
to the docs when they are generated.
I've got quite a few (~100 now!) small demo samples. For the most
part, the each:
are a complete app (al la "making sample apps")
demonstrate/test a single widget or concept.
But they are a fair bit larger than the snippets we're talking about here.
I have written them over the years from a combination of trying
out/testing stuff for myself, and answering questions for folks on the
wxPython list.
I've been looking for a while for a good place to put them, so others
can make use of them, and also test and improve them -- they certainly
need testing/updated with more recent wxPython (modification dates
back to 2008, and some may well be older)
So: should I see if I can figure out a way to re-organise these so
they could get built into the Sphinx docs? That would be pretty cool.
Maybe they could be kept as standalone runnable samples and placed in a
separate area of the documentation. They could then be browsed as a group
and the user can select the one they want to look at from there, and they
can also be linked to from the specific class documentation page for the
widget that they demo.
