将Python文档化为MS-Word可读形式

Question

我正试图为一个没有很好文档记录的小型Python代码库生成一个开发后的“接口控制文档”。为了适应就地文档模式，需要将其作为平面Word文档交付。它主要需要从代码中提取。你知道吗

到目前为止，我唯一的候选人是doxygen的.rtf功能。doxygen对Python来说也差不多。rtf也是如此。所以。有人能提出更好的解决办法吗？你知道吗

Answer 1

python社区是ReST格式的坚定支持者。在处理了大量word文档之后，我渐渐喜欢上了它。Sphinx是一个很好的文档工具，可以用来记录您的项目，http://readthedocs.org也使用它，不过对于一个小项目来说，它的设置可能有点多。你知道吗

所以我建议用ReST写，看看它是如何通过pandoc转换成word的。你知道吗

实际上，pandoc支持将以下格式转换为word和许多其他格式，因此如果您不想使用word编写文档，可以使用许多格式：

• 降价
• 重组文本（ReST）
• 纺织品
• HTML格式
• 文件簿
• 乳胶