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

2024-05-23 09:42:28 发布

您现在位置:Python中文网/ 问答频道 /正文

我想通过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?或者是通过几个print语句转储reST标记的最佳方法?


Tags: 文档脚本restpdfhtml格式sphinxphone

热门问题