跳转到主要内容

Sphinx docx构建器扩展。

项目描述

Sphinx docx构建器扩展可以从Sphinx文档源生成单个docx文件。此扩展使用python-docx模块(包含)进行docx文件生成。

功能

  • 此扩展在多平台(不需要OpenOffice或MS Word)上运行。

  • 可用的Sphinx语法和指令
    • 标题行输出

    • 段落输出(标准正文文本)

    • 图片和图指令输出

    • 项目符号列表和编号列表输出

    • 表格输出(受限)

目前,许多指令和缩进块尚不能正确工作。

设置

使用easy_install创建环境

尚未。

使用buildout创建环境

运行以下命令:’hg clone’或从http://bitbucket.org/shimizukawa/sphinxcontrib-docxbuilder下载sphinxcontrib-docxbuilder存档

$ cd /path/to/sphinxcontrib-docxbuilder
$ python bootstrap.py -d init
$ bin/buildout

运行示例

例如,运行以下命令进行sphinx-docx构建:

$ bin/example
...
Saved new file to: examples/example-0.1.docx

用法

将’sphinxcontrib-docxbuilder’设置为目标sphinx源conf.py中的‘extensions’行

extensions = ['sphinxcontrib-docxbuilder']

使用以下选项执行sphinx-build

$ bin/sphinx-build -b docx [input-dir] [output-dir]
$ ls [output-dir]
output.docx

需求

  • Python 2.6或更高版本(不支持3.x)

  • python-docx(尚未发布,但包含),感谢Mike MacCana。

  • setuptools或distriubte。

历史

0.0.1(未发布)

  • 未发布。

待办事项

功能

  • 表格输出

  • 生成目录树(处理目录树输出?通过docx功能创建?)

  • 重置非连续编号列表的编号

  • 添加分页指令

  • 实现许多指令
    • 备注

    • 警告

    • 代码高亮显示

    • 以及等等……

  • 使用dotx模板

  • 一些强调(斜体,粗体)

环境

  • docx构建器需要python-docx包,但该包未在PyPI上分发。

  • python-docx无法生成(斜体)和(粗体)模式标签。

已知问题

  • 一些缩进块输出尚未正确工作。
    • 引用块

    • 字面块

  • 图例指令的标题变成普通段落(不包括图像)。

  • python-docx临时使用模板的媒体(图像)文件夹,然后一些独立文档的媒体文件意外地共享。

  • 图像指令破坏docx格式(可能是包含非常大的文件)

项目详情


支持