ANN: wxPython Documentation

Patrick_K_O_Brien · May 6, 2003, 10:10pm

As promised, I've been working on some Python-specific wxPython
documentation. I've gotten far enough that I thought I'd announce it
on a couple of the wxPython lists, and ask for some feedback. If you
want to discuss this in detail, let's do so on the wxPython-Docs list.

This page has a link to seven resources for wxPython developers:

http://www.orbtech.com/www/wxPythonDocs.html

Here is what you'll find on that page:

wxPython Manual

···

===============

http://www.orbtech.com/www/wxPythonManual.html

This is a start on converting the wxWindows documentation, except for
the class reference, which I'm tackling in a different way.

wxPython Developer Reference

http://www.orbtech.com/www/wx/epydoc/

This is how I'm handling the class library, and was created using the
Epydoc tool. Basically, I've got a set of Python class definitions
that mirror the ones in the wxPython SWIG files, except mine have
docstrings and method signatures. Well, some of them do. I've got
the whole class hierarchy, but there is a ton of work left to get all
the docstrings and signatures in place. It would be nice to get some
funding for this effort.

wxPython Tutorial

This is really just a placeholder, so I won't even provide the link.
Robin and I are giving a wxPython tutorial at the O'Reilly Open Source
Convention on July 7, so I'll put some of that material here.

wxPython Examples

http://www.orbtech.com/www/wxPythonExamples.html

Example programs using wxPython and the new wx package syntax.

wx Package

http://www.orbtech.com/www/wxPackage.html

Explains the new prefix-less wx package.

Py Manual

http://www.orbtech.com/www/PyManual.html

Documents the Py collection of programs (formerly PyCrust) and source
code modules, including:

* PyAlaCarte
* PyAlaMode
* PyCrust
* PyFilling
* PyShell
* PyWrap

Py Developer Reference

http://www.orbtech.com/www/wx/epydoc/public/wx.py-module.html

Py source code documentation for developers, created using the Epydoc
tool. At first I had this as a separate set of epydoc files, but now
its part of the wx epydoc files, and this is just a direct link into
the wx.py package.

Let me know what you think. (I already know it is incomplete.)

And, yes, every bit of this is using the new, prefix-less wx package
and syntax.

--
Patrick K. O'Brien
Orbtech http://www.orbtech.com/web/pobrien
-----------------------------------------------
"Your source for Python programming expertise."
-----------------------------------------------

Robin · May 7, 2003, 12:17am

Patrick K. O'Brien wrote:

As promised, I've been working on some Python-specific wxPython
documentation. I've gotten far enough that I thought I'd announce it
on a couple of the wxPython lists, and ask for some feedback. If you
want to discuss this in detail, let's do so on the wxPython-Docs list.

This page has a link to seven resources for wxPython developers:

http://www.orbtech.com/www/wxPythonDocs.html

Thanks Patrick, this is looking better and better all the time.

wxPython Developer Reference

http://www.orbtech.com/www/wx/epydoc/

This is how I'm handling the class library, and was created using the
Epydoc tool. Basically, I've got a set of Python class definitions
that mirror the ones in the wxPython SWIG files, except mine have
docstrings and method signatures. Well, some of them do. I've got
the whole class hierarchy, but there is a ton of work left to get all
the docstrings and signatures in place. It would be nice to get some
funding for this effort.

Please don't spend a whole lot of time putting the details in the decorator classes. I'm sure that I'll be able to get SWIG to generate something that can be transformed into the decorators with accurate method signatures and etc. (and I'll have time to work on it again soon.) Otherwise I foresee it being a maintenance nightmare to keep things in sync.

···

--
Robin Dunn
Software Craftsman
http://wxPython.org Java give you jitters? Relax with wxPython!

Philippe_Ney · May 7, 2003, 7:19am

As promised, I've been working on some Python-specific wxPython
documentation. I've gotten far enough that I thought I'd announce it
on a couple of the wxPython lists, and ask for some feedback. If you
want to discuss this in detail, let's do so on the wxPython-Docs list.

This page has a link to seven resources for wxPython developers:

http://www.orbtech.com/www/wxPythonDocs.html

Woaw, cool!
wxPython documentation was something missing... till now

Thanks for this great work!
-philippe

Frank_Millman · May 7, 2003, 10:39am

I have just noticed that the WXK constants for PageUp and PageDown seem to
be incorrect. On both Windows and Linux the keycodes are 312 and 313
respectively, but WXK_PAGEUP and WXK_PAGEDOWN show 368 and 369.

No rush - I just test for the literal values instead - but I thought I would
mention it.

Frank Millman

Werner_F_Bruhin1 · May 7, 2003, 5:00pm

Patrick,

Keep up the good work, the lack of Python specific doc made me nearly give up on wxPython and Python. It was and still is frustrating.

BTW, can't find your wxPhyton book (or is it the one about PythonCard on O'Reilly?), maybe a link to it to your homepage, I for one will probably buy it the next time I order some books.

See you
Werner

Patrick K. O'Brien wrote:

···

As promised, I've been working on some Python-specific wxPython
documentation. I've gotten far enough that I thought I'd announce it
on a couple of the wxPython lists, and ask for some feedback. If you
want to discuss this in detail, let's do so on the wxPython-Docs list.

This page has a link to seven resources for wxPython developers:

http://www.orbtech.com/www/wxPythonDocs.html

Here is what you'll find on that page:

wxPython Manual

http://www.orbtech.com/www/wxPythonManual.html

This is a start on converting the wxWindows documentation, except for
the class reference, which I'm tackling in a different way.

wxPython Developer Reference

http://www.orbtech.com/www/wx/epydoc/

This is how I'm handling the class library, and was created using the
Epydoc tool. Basically, I've got a set of Python class definitions
that mirror the ones in the wxPython SWIG files, except mine have
docstrings and method signatures. Well, some of them do. I've got
the whole class hierarchy, but there is a ton of work left to get all
the docstrings and signatures in place. It would be nice to get some
funding for this effort.

wxPython Tutorial

This is really just a placeholder, so I won't even provide the link.
Robin and I are giving a wxPython tutorial at the O'Reilly Open Source
Convention on July 7, so I'll put some of that material here.

wxPython Examples

http://www.orbtech.com/www/wxPythonExamples.html

Example programs using wxPython and the new wx package syntax.

wx Package

http://www.orbtech.com/www/wxPackage.html

Explains the new prefix-less wx package.

Py Manual

http://www.orbtech.com/www/PyManual.html

Documents the Py collection of programs (formerly PyCrust) and source
code modules, including:

* PyAlaCarte
* PyAlaMode
* PyCrust
* PyFilling
* PyShell
* PyWrap

Py Developer Reference

http://www.orbtech.com/www/wx/epydoc/public/wx.py-module.html

Py source code documentation for developers, created using the Epydoc
tool. At first I had this as a separate set of epydoc files, but now
its part of the wx epydoc files, and this is just a direct link into
the wx.py package.

Let me know what you think. (I already know it is incomplete.)

And, yes, every bit of this is using the new, prefix-less wx package
and syntax.

Patrick_K_O_Brien · May 7, 2003, 5:18pm

"Werner F. Bruhin" <werner.bruhin@free.fr> writes:

Patrick,

Keep up the good work, the lack of Python specific doc made me nearly
give up on wxPython and Python. It was and still is frustrating.

Thanks. I feel your pain.

BTW, can't find your wxPhyton book (or is it the one about PythonCard
on O'Reilly?), maybe a link to it to your homepage, I for one will
probably buy it the next time I order some books.

The book isn't published yet, and isn't finished yet either, in part
because I took the time to try to solve the underlying problem of a
lack of Python-specific documentation for wxPython.

···

--
Patrick K. O'Brien
Orbtech http://www.orbtech.com/web/pobrien
-----------------------------------------------
"Your source for Python programming expertise."
-----------------------------------------------

Robin · May 7, 2003, 5:34pm

Frank Millman wrote:

I have just noticed that the WXK constants for PageUp and PageDown seem to
be incorrect. On both Windows and Linux the keycodes are 312 and 313
respectively, but WXK_PAGEUP and WXK_PAGEDOWN show 368 and 369.

No rush - I just test for the literal values instead - but I thought I would
mention it.

For historical reasons (that I don't remember at the moment) the PgUP and PgDn keys are mapped to WXK_PRIOR and WXK_NEXT.

···

--
Robin Dunn
Software Craftsman
http://wxPython.org Java give you jitters? Relax with wxPython!

Kevin_Cole · May 7, 2003, 5:47pm

Just a suggestion of which you may already be aware: Twisted Matrix
Laboratories (http://www.twistedmatrix.com/) has this program called
"lore" reputed to make very pretty python documentation in both PDF
and HTML, provided you're running a Twisted Matrix web server...

···

On Wed, May 07, 2003 at 12:18:26PM -0500, Patrick K. O'Brien wrote:

"Werner F. Bruhin" <werner.bruhin@free.fr> writes:

> Patrick,
>
> Keep up the good work, the lack of Python specific doc made me nearly
> give up on wxPython and Python. It was and still is frustrating.

Thanks. I feel your pain.

> BTW, can't find your wxPhyton book (or is it the one about PythonCard
> on O'Reilly?), maybe a link to it to your homepage, I for one will
> probably buy it the next time I order some books.

The book isn't published yet, and isn't finished yet either, in part
because I took the time to try to solve the underlying problem of a
lack of Python-specific documentation for wxPython.

--
Patrick K. O'Brien
Orbtech http://www.orbtech.com/web/pobrien
-----------------------------------------------
"Your source for Python programming expertise."
-----------------------------------------------

---------------------------------------------------------------------
To unsubscribe, e-mail: wxPython-users-unsubscribe@lists.wxwindows.org
For additional commands, e-mail: wxPython-users-help@lists.wxwindows.org

--
Kevin Cole | Key ID: 0xE6F332C7
Gallaudet University | WWW: http://gri.gallaudet.edu/~kjcole/
Hall Memorial Bldg S-419 | V/TTY: (202) 651-5135
Washington, D.C. 20002-3695 | FAX: (202) 651-5746

Patrick_K_O_Brien · May 7, 2003, 6:15pm

Kevin Cole <kjcole@gri.gallaudet.edu> writes:

Just a suggestion of which you may already be aware: Twisted Matrix
Laboratories (http://www.twistedmatrix.com/) has this program called
"lore" reputed to make very pretty python documentation in both PDF
and HTML, provided you're running a Twisted Matrix web server...

Thanks for the suggestion. I've looked at Lore, but prefer
reStructuredText and the Docutils utilities for hand-written text
documentation. The wxPython API documentation is automatically
generated using epydoc, which is the same tool Twisted uses to
document the Twisted API.

···

--
Patrick K. O'Brien
Orbtech http://www.orbtech.com/web/pobrien
-----------------------------------------------
"Your source for Python programming expertise."
-----------------------------------------------