我的问题是如何以编程方式驱动Sphinx autodoc指令。我从2003年就看到了关于狮身人面像零件的东西,但是现在的方法是什么呢?
例子:
给定文件
测试.rst
:
ð
######
.. autoclass:: mymodule.MyClass
:members: __init__, process
ð
######
以及
class MyClass:
def __init__(self, *args, **kwargs):
""" init """
def process(self, f_out : "file"):
"process"
print("I am processing")
我可以用
sphinx-build -a . ./out
出去/测试.html
给我:
我感兴趣的部分只是:
<dl class="class">
<dt id="mymodule.MyClass">
<em class="property">class </em><code class="sig-prename descclassname">mymodule.</code><code
class="sig-name descname">MyClass</code><span class="sig-paren">(</span><em class="sig-param">*args</em>,
<em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink"
href="#mymodule.MyClass" title="Permalink to this definition">¶</a></dt>
<dd>
âï¸âï¸âï¸âï¸
</dd>
</dl>