sphinx_wxoptimize iconsphinx_wxoptimize 1.2

Convert sphinx-generated htmlhelp files into versions optimized for reading using the wxHtmlHelp browser
The sphinx document processor generates HTML that uses more advanced syntax than the HtmlHelp browser in wxPython and wxWidgets can render. sphinx_wxoptimize uses the htmlhelp files generated by sphinx as input and attempts to remove elements that confuse the wxHtmlHelp system while adding or modifying elements in an attempt to allow the wxHtmlHelp to render the HTML as closely as possible to the HTML as viewed by a modern browser.

This package provides a script sphinx-wxoptimize that is designed to be integrated into your make htmlhelp target that will automatically reprocess the sphinx-generated htmlhelp files and convert them to be better rendered in the wxPython or wxWidgets wxHtmlHelpController.
Automatic Integration with Sphinx

In your sphinx Makefile, change the htmlhelp target from:

 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp


 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 sphinx-wxoptimize _build/htmlhelp


Installation is through the usual python packaging commands, either by downloading the source archive and installing manually:

python setup.py install

or using easy_install:

easy_install sphinx-wxoptimize

Using easy_install will automatically install the prerequisite BeautifulSoup library.

last updated on:
November 19th, 2009, 10:46 GMT
developed by:
Rob McMullen
license type:
GPL (GNU General Public License) 
ROOT \ Text Editing&Processing \ Markup


In a hurry? Add it to your Download Basket!

user rating



What's New in This Release:
  • Fixed bug in single paragraph definition lists including inline markup (italics, bold, etc.)
read full changelog

Add your review!