python - 将 Python 记录为 MS Word 可读格式

Question

我正在尝试为一个没有特别详细记录的小型 Python 代码库生成一个开发后的“接口控制文档”。为了适应就地文档架构，它需要作为平面 Word 文档提供。它主要需要从代码中提取出来。

到目前为止，我唯一的候选人是 doxygen 的 .rtf 功能。doxygen 对 Python 来说有点马马虎虎。rtf 也是如此。所以。任何人都可以提出更好的解决方案吗？

score 2 · Accepted Answer

python 社区是ReST格式的坚定支持者。在不得不处理大量的word文档之后，我已经爱上了它。Sphinx是一个很棒的文档工具，可用于记录您的项目，并由http://readthedocs.org使用，尽管对于一个小项目来说设置它可能有点多。

因此，我建议使用ReST 编写代码，并通过 pandoc 查看它如何转换为单词。

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

1 回答 1