python - 如何从 python 生成 reST/sphinx 源？

Question

我想通过 reST 生成文档，但不想手动编写 reST 源代码，而是让 python 脚本执行此操作，然后使用 sphinx 生成其他格式(HTML、PDF)。

假设我有一本二进制格式的电话簿。现在我使用一个 python 脚本来解析它并生成一个包含所有名称和数字的文档:

  phone_book = PhonebookParser("somefile.bin")

  restdoc = restProducer.NewDocument()
  for entry in phone_book:
    restdoc.add_section( title = entry.name, body = entry.number )

  restdoc.write_to_file("phonebook.rst")

然后我会继续调用 sphinx 来生成 pdf 和 html:

  > sphinx phonebook.rst -o phonebook.pdf
  > sphinx phonebook.rst -o phonebook.html

是否有一个 python 模块(在上面的示例中又称为 restProducer)提供用于生成 reST 的 API？或者是通过几个打印语句转储 reST 标记的最佳方法？

Answer 1

1. 参见 Automatically Generating Documentation for All Python Package Contents .

2. 即将到来的Sphinx 1.1发布包括 sphinx-apidoc.py脚本。

编辑:

既然您已经对问题做了更多解释，我会说:选择“通过几个打印语句转储 reST 标记”选项。你似乎已经在按照这些思路思考了。为什么不尝试实现一个简约的 restProducer？