如何从python生成reST/sphinx源代码?

dan*_*tje 6 python restructuredtext documentation-generation python-sphinx

我想通过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")
Run Code Online (Sandbox Code Playgroud)

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

  > sphinx phonebook.rst -o phonebook.pdf
  > sphinx phonebook.rst -o phonebook.html
Run Code Online (Sandbox Code Playgroud)

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

mzj*_*zjn 5

  1. 请参阅自动生成所有Python软件包内容的文档

  2. 即将发布的Sphinx 1.1版本包括一个sphinx-apidoc.py脚本。

编辑:

现在,您已经对问题进行了进一步解释,我会说:选择“通过几个打印语句转储reST标记”选项。您似乎已经在考虑这些思路。为什么不尝试实现简约restProducer