将sphinx生成的htmlhelp文件转换为使用wxhtmlhelp浏览器进行读取优化的版本
sphinx_wxoptimize的Python项目详细描述
sphinx文档处理器生成使用更高级语法的html 而wxpython和wxwidgets中的htmlhelp浏览器则无法呈现。这个程序 使用sphinx生成的htmlhelp文件作为输入并尝试删除 在添加或修改元素时混淆wxhtmlhelp系统的元素 为了让wxhtmlhelp尽可能地呈现html 可以用一个现代化的浏览器来查看html。
此包提供一个脚本sphinx-wxoptimize,该脚本旨在 被集成到您的make htmlhelp目标中,该目标将自动 重新处理sphinx生成的htmlhelp文件并将其转换为更好的 在wxpython或wxwidgets wxhtmlhelpcontroller中呈现。
功能
当前将以下内容转换为在wxhtmlhelpcontroller中更好地呈现:
- 修复定位链接
- 删除由div标记引起的额外换行符
- 在居中对齐的图像后添加换行符
- 修复定义列表中多个段落的左边距问题
- 删除不必要的css和javascript
- 从索引页中删除搜索链接
示例
有关sphinx-wxoptimize输出的示例,请访问 Peppy User Manual。
与狮身人面像自动集成
在sphinx makefile中,将htmlhelp目标更改为:
htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
收件人:
htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp sphinx-wxoptimize $(BUILDDIR)/htmlhelp
安装
安装是通过常用的python打包命令进行的,或者通过 下载源存档并手动安装:
python setup.py install
或者使用简易安装:
easy_install sphinx-wxoptimize
使用easy_install将自动安装必备的BeautifulSoup 图书馆。
开发
请使用Google Code站点报告任何错误,添加任何功能 请求,或签出Subversion源代码存储库。
更改日志
1.2
- 修复了包含内联标记的单个段落定义列表中的错误 (斜体、粗体等)
1.1
- 现在从静态目录中删除不必要的css和javascript文件 减小分布式htmlhelp的大小。WXHTMLHELP控制器不能 无论如何都要使用css和javascript,所以不需要包含它。
1.0
- 初始版本