Sphinx autosummary,包括和基类

时间:2014-03-05 23:07:46

标签: python inheritance include python-sphinx summary

我觉得在编写继承的类属性时,我已经尝试了在可维护的工作流程中创建带有工作链接的自动总结表。我真的可以使用小费。

我认为这样的事情会很好......

base.py:

"""
.. -- include below --
.. autosumary::

    BaseFoo.a
    BaseFoo.b

.. -- include above --
"""
class BaseFoo(object):
    @property
    def a(self): pass

    @property
    def b(self): pass

foo.py:

"""
Inherited from :class:`base.BaseFoo` ...

.. include:: base.py
    :start-after: --- include below ---
    :end-before: --- include above ---
"""
class Foo(BaseFoo):
    pass

问题是Sphinx不会在autosummary表中创建链接,因为类名不匹配。即使使用自动模块继承成员,它似乎也不理解继承(继承的成员是自动记录的,只是表链接不起作用)。

我尝试使用replace指令,这本来是一个很好的方法,但是autosummary无法生成任何东西。

我尝试使用带有前导.的属性(例如.a),认为自动完成可能会启动。

Autosummary似乎是系统中的一个手动瓶颈。必须有更好的方法。

有什么想法吗?

P.S。有超过1500的人可以为自体乳房或sphinx-autosummary或​​任何有意义的东西添加标签吗?

0 个答案:

没有答案