[PyOpenGL-Devel] Documentation-generation reworking basically finished...
Brought to you by:
mcfletch
From: Mike C. F. <mcf...@ro...> - 2003-05-02 09:08:13
|
I have just completed what appears to be a fully functional cross-browser documentation-generation pass (finally :) ). Basically, this uses a MathML to HTML+CSS+Javascript converter to provide a "lowest common denominator" HTML version of the reference documentation, and then provides the xhtml version with full MathML for those browsers which support it. You can see the new manual here: http://pyopengl.sourceforge.net/documentation/manual/index.html Links to pages in the reference manual should still be functional, though links to users-manual pages will no longer operate. I've begun pulling the "users manual" material out of the docbook format, consolidating out the old material as I go. It makes a single moderate-length web-page which you can find here: http://pyopengl.sourceforge.net/documentation/opengl_diffs.html (I haven't done much cleanup or expansion on the text, people who would like to expand/improve a section are certainly welcome to do such a thing). As I have been working with the build_doc command I have added a significant amount of commenting and documentation so that future administrators (or myself in a while) can more easily understand what is going on and why. I've also added notes to the installation.html file regarding how to set up the documentation-building environment. I haven't yet tried building the htmlhelp version of the documentation, as I have little confidence that the javascript-based lowest-common-denominator MathML will properly operate from within that environment. Enjoy yourselves, Mike _______________________________________ Mike C. Fletcher Designer, VR Plumber, Coder http://members.rogers.com/mcfletch/ |