api docs snapshot

I've put a snapshot of the new api docs at

  alldunn.com slash wxPython slash api

(I didn't specify the real URL to help keep out the spiders that don't honor the robots.txt file...)

As long as the bandwidth utilization doesn't jump too high I'll periodically put snapshots there as I am developing the docs and doc tools. Of course eventually they will become part of the main wxPython website, will be downloadable, etc.

A couple notes on what is currently there:

* The wx.lib and other subpackages are currently excluded as it doubles the time to generate the docs and there are a buch of docstrings that cause epydoc errors, so until I'm ready to start focusing on the docs for those modules I'll save the generation time.

* I also turned off the listing of inherited methods in each class, (this is one of my epydoc customizations.) This is also mainly for saving time while I am working on the docs, excluding the generation of that part of each page chops off about 2/3 of the generation time. It's easy to put back for the final product though.

* There is still lots of content that needs to be added, but what is there has been significantly updated with more details, reST markup, etc. and tweaks have been done to the source *.i files, SWIG and epydoc to make what is auto-generated to be more informative. Now that I've got a basic feel for what can be done, and how to do it, I expect to make steady progress on the rest of the content.

···

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

Robin Dunn wrote:

I've put a snapshot of the new api docs at

    alldunn.com slash wxPython slash api

It's looking great, Robin. Can it be generated in a printable format too?

* There is still lots of content that needs to be added

As an example I see that only a few of the DC methods are documented. What does it take to add that kind of thing? Docstrings? Also, the subclasses of DC have no explanation of what they are? Is thins another docstring issue?

It looks like there is a LOT of work to be done once the framework is all in place. Maybe we can make this s group effort...maybe a sprint at the Open Source convention this summer?

-Chris

···

--
Christopher Barker, Ph.D.
Oceanographer
                                         
NOAA/OR&R/HAZMAT (206) 526-6959 voice
7600 Sand Point Way NE (206) 526-6329 fax
Seattle, WA 98115 (206) 526-6317 main reception

Chris.Barker@noaa.gov

Chris Barker wrote:

Robin Dunn wrote:

I've put a snapshot of the new api docs at

    alldunn.com slash wxPython slash api

It's looking great, Robin. Can it be generated in a printable format too?

Epy can make latex and pdf but I havn't tried it yet. Also I think that it may still be limited in what it can output if you are using restructuredtext format, (which I am) but it should be brought up to par in future versions.

* There is still lots of content that needs to be added

As an example I see that only a few of the DC methods are documented.

Yep, I havn't gotten there yet.

What does it take to add that kind of thing? Docstrings?

Yep.

Also, the subclasses of DC have no explanation of what they are? Is thins another docstring issue?

Yep.

It looks like there is a LOT of work to be done once the framework is all in place. Maybe we can make this s group effort...maybe a sprint at the Open Source convention this summer?

Could be, but why wait that long? :wink:

Docstring updates for the wx.lib modules should be easy for anybody to do, just checkout from CVS, make the changes, test with epydoc and send me patches.

For the extension modules it woudl be a bit trickier for others to help, but still doable. Once all the details are worked out I'll put a how-to in the wiki or something.

···

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

Robin Dunn wrote:

...maybe a sprint

at the Open Source convention this summer?

Could be, but why wait that long? :wink:

Well, we don't have to , but if we make a party out of it, I think we could get a lot done!

Docstring updates for the wx.lib modules should be easy for anybody to do, just checkout from CVS, make the changes, test with epydoc and send me patches.

For the extension modules it woudl be a bit trickier for others to help, but still doable. Once all the details are worked out I'll put a how-to in the wiki or something.

Good idea. I hope I'll be able to find the time to help.

-Chris

···

--
Christopher Barker, Ph.D.
Oceanographer
                                         
NOAA/OR&R/HAZMAT (206) 526-6959 voice
7600 Sand Point Way NE (206) 526-6329 fax
Seattle, WA 98115 (206) 526-6317 main reception

Chris.Barker@noaa.gov