斯芬克斯自动总结和动态方法

时间:2012-01-11 02:24:31

标签: python python-sphinx

我发现使用setattr()制作动态生成的类方法和属性有很多用处。我也一直在使用sphinx来创建文档,这太棒了。

问题是如果属性和方法是动态的,我不能使用sphinx的autosummary功能。有一个聪明的方法来做到这一点?初始化时会创建动态方法和属性。

1 个答案:

答案 0 :(得分:0)

试试这个(这有点古怪):

  1. conf.py文件中创建班级实例。
  2. 使用autodoc-process-docstring事件触发处理程序(您需要编写)以将各种动态方法的__doc__元素从您在1)中创建的实例复制到输出中类。
  3. 这不是一个简单的解决方案,也不是一件容易的事,而且甚至可能都不可能,但如果你能弄清楚如何在正确的时间让事情发生,那么它可能会有效。