如何使用Sphinx自动记录Python?

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (2)
  • 关注 (0)
  • 查看 (86)

是否有一种方法可以递归地自动记录模块或包中包含类和函数?

我认为添加autofunctionautomodule每个函数的指令;必须有一种方法来使流程自动化,否则我完全不认为使用Sphinx有什么意义。

.. automodule:: segments.segments

    .. autoclass:: segments.segments.Seg

        .. automethod:: Seg.method_1

        .. automethod:: Seg.method_2

        .. automethod:: Seg.method_3

        .......

        .. automethod:: Seg.method_n

这要求我手动剪切和粘贴所有方法名,并相应地更新文档,我希望有这样的命令:

.. automodule:: segments.segments

    .. autoclass:: segments.segments.Seg

        .. MAGIC COMMAND: Automatically print the docstrings and signatures 
           of all Seg() methods.
提问于
用户回答回答于
用户回答回答于

扫码关注云+社区

领取腾讯云代金券