[wxWidgets.git] / wxPython / distrib / README.viewdocs.txt

wxPython-docs
-------------

The wxWidgets docs can now be viewed on non-Win32 platforms with a
nice viewer modeled after the MS HTMLHelp viewer.  Simply execute the
viewdocs.py script located in this directory and you're all set.
(You'll need to first have wxPython installed and accessible via the
PYTHONPATH.)

You can also add other HTML books to be displayed by the viewer simply
by dropping their .zip file here, viewdocs.py will find them
automatically and add them to the list.  The zip file just needs to
contain a .hhp file that defines the contents of the book.  See the
docs on wxHtmlHelpController for details.

If you'd still like to view these docs in your regular browser you can
simply unzip each of the books into their own directory.
Commit	Line	Data
f81ef370 RD	1	wxPython-docs
f81ef370 RD	2	-------------
1e4a197e	3
8027eb22	4	The wxWidgets docs can now be viewed on non-Win32 platforms with a
1e4a197e RD	5	nice viewer modeled after the MS HTMLHelp viewer. Simply execute the
	6	viewdocs.py script located in this directory and you're all set.
	7	(You'll need to first have wxPython installed and accessible via the
	8	PYTHONPATH.)
	9
	10	You can also add other HTML books to be displayed by the viewer simply
	11	by dropping their .zip file here, viewdocs.py will find them
	12	automatically and add them to the list. The zip file just needs to
	13	contain a .hhp file that defines the contents of the book. See the
	14	docs on wxHtmlHelpController for details.
	15
1fded56b	16	If you'd still like to view these docs in your regular browser you can
1e4a197e	17	simply unzip each of the books into their own directory.