将Python记录为MS Word可读格式

时间:2013-01-16 05:04:37

标签: python ms-word doc

我正在尝试为一个没有特别好记录的小型Python代码库生成一个post-dev“接口控制文档”。要适合就地文档架构,需要将其作为平面Word文档提供。它需要主要从代码中提取。

到目前为止,我唯一的候选人是doxygen的.rtf功能。使用Python,doxygen有点不太适合。 rtf也是如此。所以。任何人都可以提出更好的解决方案吗?

1 个答案:

答案 0 :(得分:2)

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

因此,我建议您在ReST中撰写文章,并通过pandoc查看其如何转换为字词。

实际上,pandoc支持将以下格式转换为单词和许多其他格式,因此如果您想避免使用单词编写,您可以编写很多格式的文档:

  • markdown
  • reStructuredText(ReST)
  • textile
  • HTML
  • DocBook
  • 乳胶