Как сгенерировать исходный код reST / sphinx из python?

Я хотел бы сгенерировать документацию через reST, но не хочу писать исходный код reST вручную, но позвольте скрипту python сделать это, а затем создать другие форматы (HTML, PDF) с помощью sphinx .

Представьте, что у меня есть телефонная книга в двоичном формате. Теперь я использую сценарий 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 в приведенном выше примере), который предлагает API для генерации reST? Или это лучший способ просто сбросить разметку reST с помощью пары операторов печати?

6
задан dantje 15 March 2011 в 18:36
поделиться