This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

The sphinx document processor generates HTML that uses more advanced syntax than the HtmlHelp browser in wxPython and wxWidgets can render. This program 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.

Features

Currently converts the following to be better rendered in wxHtmlHelpController:

  • fixes anchor links
  • removes extra linebreaks caused by div tags
  • adds a line break after center-aligned images
  • fixes left margin issues of mulitple paragraphs in definition lists
  • removes unnecessary CSS and JavaScript
  • removes the search link from the index page

Example

For an example of the output of sphinx-wxoptimize, visit the Peppy User Manual.

Automatic Integration with Sphinx

In your sphinx Makefile, change the htmlhelp target from:

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

to:

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

Installation

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.

Development

Please use the Google Code site to report any bugs, add any feature requests, or check out the subversion source code repository.

ChangeLog

1.2

  • Fixed bug in single paragraph definition lists including inline markup (italics, bold, etc.)

1.1

  • Now removes unnecessary CSS and JavaScript files from _static directory to reduce the size of the distributed HtmlHelp. The wxHtmlHelpController can’t use the CSS and JavaScript anyway, so there’s no need to include it.

1.0

  • Initial release
Release History

Release History

1.2

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinx_wxoptimize-1.2.tar.gz (7.2 kB) Copy SHA256 Checksum SHA256 Source Nov 19, 2009

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting