{ "info": { "author": "Rob McMullen", "author_email": "robm@users.sourceforge.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License (GPL)", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Software Development :: Documentation", "Topic :: Text Processing :: Markup :: HTML" ], "description": "The sphinx document processor generates HTML that uses more advanced syntax\nthan the HtmlHelp browser in wxPython and wxWidgets can render. This program\nuses the htmlhelp files generated by sphinx as input and attempts to remove\nelements that confuse the wxHtmlHelp system while adding or modifying elements\nin an attempt to allow the wxHtmlHelp to render the HTML as closely as\npossible to the HTML as viewed by a modern browser.\n\nThis package provides a script ``sphinx-wxoptimize`` that is designed to\nbe integrated into your ``make htmlhelp`` target that will automatically\nreprocess the sphinx-generated htmlhelp files and convert them to be better\nrendered in the wxPython or wxWidgets wxHtmlHelpController.\n\nFeatures\n========\n\nCurrently converts the following to be better rendered in wxHtmlHelpController:\n\n* fixes anchor links\n* removes extra linebreaks caused by div tags\n* adds a line break after center-aligned images\n* fixes left margin issues of mulitple paragraphs in definition lists \n* removes unnecessary CSS and JavaScript\n* removes the search link from the index page\n\nExample\n=======\n\nFor an example of the output of ``sphinx-wxoptimize``, visit the\n`Peppy User Manual`__.\n\n__ http://peppy.flipturn.org/manual/index.html\n\n\nAutomatic Integration with Sphinx\n=================================\n\nIn your sphinx Makefile, change the htmlhelp target from::\n\n htmlhelp:\n $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\nto::\n\n htmlhelp:\n $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n sphinx-wxoptimize $(BUILDDIR)/htmlhelp\n\n\nInstallation\n============\n\nInstallation is through the usual python packaging commands, either by\ndownloading the source archive and installing manually::\n\n python setup.py install\n\nor using easy_install::\n\n easy_install sphinx-wxoptimize\n\nUsing easy_install will automatically install the prerequisite BeautifulSoup__\nlibrary.\n\n__ http://pypi.python.org/pypi/BeautifulSoup\n\nDevelopment\n===========\n\nPlease use the `Google Code`__ site to report any bugs, add any feature\nrequests, or check out the subversion source code repository.\n\n__ http://code.google.com/p/sphinx-wxoptimize/\n\n\nChangeLog\n=========\n\n1.2\n---\n\n* Fixed bug in single paragraph definition lists including inline markup\n (italics, bold, etc.)\n\n1.1\n---\n\n* Now removes unnecessary CSS and JavaScript files from _static directory to\n reduce the size of the distributed HtmlHelp. The wxHtmlHelpController can't\n use the CSS and JavaScript anyway, so there's no need to include it.\n\n1.0\n---\n\n* Initial release", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://pypi.python.org/pypi/sphinx-wxoptimize/", "keywords": "sphinx,htmlhelp,python,wxwidgets,wxpython,documentation", "license": "GPL", "maintainer": null, "maintainer_email": null, "name": "sphinx_wxoptimize", "package_url": "https://pypi.org/project/sphinx_wxoptimize/", "platform": "any", "project_url": "https://pypi.org/project/sphinx_wxoptimize/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://pypi.python.org/pypi/sphinx-wxoptimize/" }, "release_url": "https://pypi.org/project/sphinx_wxoptimize/1.2/", "requires_dist": null, "requires_python": null, "summary": "Convert sphinx-generated htmlhelp files into versions optimized for reading using the wxHtmlHelp browser", "version": "1.2" }, "last_serial": 799889, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "c96bde1e26d45b5d89ea5e25f865563b", "sha256": "d0239fc977909be0727045506a9411edf1702d1a701364bd1c60d4d402a1c18c" }, "downloads": -1, "filename": "sphinx_wxoptimize-1.0.tar.gz", "has_sig": false, "md5_digest": "c96bde1e26d45b5d89ea5e25f865563b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6301, "upload_time": "2009-11-10T18:56:26", "url": "https://files.pythonhosted.org/packages/80/f9/9612a9053ec11515aee0fce39cf0f1d72941767ce5db4abecc1d3c968bf3/sphinx_wxoptimize-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "5c74aa639c2cff6d5e68b70581cdb312", "sha256": "a027c134c8208777aedf217381374e3d83cb9e33f1b26ff0f1b6099d3b093fd7" }, "downloads": -1, "filename": "sphinx_wxoptimize-1.1.tar.gz", "has_sig": false, "md5_digest": "5c74aa639c2cff6d5e68b70581cdb312", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6823, "upload_time": "2009-11-11T17:56:46", "url": "https://files.pythonhosted.org/packages/cd/bc/85489bdebce4ab08dd9705d873d28e564606969306d60f30ce38b4d97ff9/sphinx_wxoptimize-1.1.tar.gz" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "03b67b28529b16d51f9fe7b621e63057", "sha256": "db31774f9ba2eca690206c0711ef8935e8a572da492bbe5d9bbf1653b2787fef" }, "downloads": -1, "filename": "sphinx_wxoptimize-1.2.tar.gz", "has_sig": false, "md5_digest": "03b67b28529b16d51f9fe7b621e63057", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7160, "upload_time": "2009-11-19T05:41:59", "url": "https://files.pythonhosted.org/packages/da/17/7dab3c4097e4535fe55ec562c4d579b9eb762ad23e55f6f1f1cb48a9941f/sphinx_wxoptimize-1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "03b67b28529b16d51f9fe7b621e63057", "sha256": "db31774f9ba2eca690206c0711ef8935e8a572da492bbe5d9bbf1653b2787fef" }, "downloads": -1, "filename": "sphinx_wxoptimize-1.2.tar.gz", "has_sig": false, "md5_digest": "03b67b28529b16d51f9fe7b621e63057", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7160, "upload_time": "2009-11-19T05:41:59", "url": "https://files.pythonhosted.org/packages/da/17/7dab3c4097e4535fe55ec562c4d579b9eb762ad23e55f6f1f1cb48a9941f/sphinx_wxoptimize-1.2.tar.gz" } ] }