仅自动对从库内部实现或继承的成员进行自动docdoc

时间:2019-03-17 12:21:27

标签: python python-sphinx autodoc

我正在尝试在sphinx中自动为我的库类添加文档,我希望它们包含两个简单的内容:

  • 为每个类显示我已经实现的方法(常规和__special __)。

  • 要为每个类显示仅在此程序包内部实现的继承方法。

从我的角度来看,当您要记录图书馆资料时,这是一个非常普遍的愿望,所以我希望有人能弄清楚该怎么做。

所以我当前的自动文档模板如下:

:mod:`{{module}}`.{{objname}}
{{ underline }}==============

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
   :special-members:

从以下两个事实观察到此模板的不足:

  • 具有pandas扩展名的DataFrame sphinx尝试导入所有DataFrame文档字符串并产生一个大错误输出(从conf.py启用了intersphinx),这与我定义的方法无关。

    < / li>
  • 记录ABC狮身人面像的特殊方法会导入一堆我尚未实现的方法。

0 个答案:

没有答案