docxsphinx 1.0.0

简介

此存储库已从

https://bitbucket.org/shimizukawa/sphinxcontrib-docxbuilder

并且做了一些重大的修改。中列出了主要更改 发行说明（todo添加发行说明）。在

安装

最新的最新版本可以通过

^{tt1}$

安装开发版本

^{tt2}$

或者，可以在本地克隆和安装存储库

^{tt3}$

安装之后，sphinx项目中的`make docx`应该可以工作了 （见下一节）

生成docx文档

假设狮身人面像项目已经到位。至少有一个变化 必须做到配置文件以便能够生成docx文件。在

以下行必须添加到配置文件：

^{tt5}$

示例项目位于examples

• REPO_ROOT/examples/sample_1 : default example (from the original repo)
• REPO_ROOT/examples/sample_2 : example tested with make docx
• REPO_ROOT/examples/sample_3 : example tested with make docx with a custom style

文字样式

自定义word样式文件可以通过添加

^{tt6}$

直到配置文件（或文件中的任何位置）

发展

设置开发环境（确保安装了pipenv）：

^{tt7}$

无论何时进行更改，都需要通过以下方式重新安装程序包：

^{tt8}$

因为测试是使用命令sphinx-build运行的，因此 在环境路径中。在

也可以使用运行测试（但不建议这样做，而且 以后删除）：

^{tt10}$

调试生成过程

^{tt11}$

使用当前的 开发docxsphinx源，例如sphixn项目sample_2：

^{tt14}$

分析有助于查看代码的哪些部分是 在模块src/docxsphinx/writer.py中访问。例如 要分析sample_2，可以使用以下模式：

^{tt17}$

美国石油学会

另请参见

REPO_ROOT/src/README.md (outdated - but useful) REPO_ROOT/src/docxsphinx/docx/README.md