[PyOpenGL-Users] documentation

[Tarn W. B. <twb...@ma...>]

I'd like to reiterate some points about documentation and participation in
the PyOpenGL project.

First off HTML and PDF documentation is included with PyOpenGL in the
"OpenGL/doc" directory and HTML docs are available online at
http://pyopengl.sf.net/documentation/  The online docs actually represent
the "in development" docs so may have expanded sections especially the
reference section.  For users trying to understand the package layout of
PyOpenGL and the general conventions of functions the User's Guide and the
Pydoc documentation is recommended.  If you have pydoc on your machine than
you can get access to this locally or you can use the online stuff at the
above link.

For people who are interested in the internals of PyOpenGL I recommend
reading the "internals" section of the manual and a willingness to spend
some time looking at the code.  I am more than willing to answer questions
about these topics especially in light of the fact that the current
documentation is obviously incomplete, but I'm likely to get frustrated if I
feel that someone hasn't spent the time to look at the docs themselves.
This is mostly because my own time is limited and there are PyOpenGL
enhancements that I want to work on myself, but will be unable to do so if I
am overwhelmed with queries from those unwilling to invest time themselves.

thanks,
Tarn