Лучший способ документировать модуль Python, который генерируется C API?

Question

Я встроил и расширил python внутри своего приложения C, и теперь я хочу это документировать. Я определил модуль, используя C API, поэтому инструмент pydoc его не увидит (верно?).

На данный момент лучший способ, который я могу придумать, - это использовать модуль «pydoc» на моем модуле во время выполнения (следовательно, модуль расширения, который я определил, будет присутствовать). Это должно позволить мне выкладывать HTML и текстовые версии документов для моего API.

Что-то вроде (от макушки):

import pydoc
import sys

d = pydoc.HTMLDoc()
print(d.page("my api", d.docmodule(sys.modules["mymodule"])))

Есть ли лучший способ?

Answer 1

Я не совсем уверен, как вы используете C-API (поскольку вы только что сказали, что вы встроили и расширили Python в своем приложении C).

Однако pydoc импортирует модуль и использует самоанализ для генерации документации для модуля, поэтому, если вы запустите его на скомпилированном модуле, он все равно будет работать.Дело в том, что он не смотрит на источник.