Sphinx autodoc'u belirli işlevler için geçersiz kılmak mümkün mü?

Question

Bir dizi modülü otomatik olarak belgelemek için Sphinx'in autodoc eklentisini kullanıyorum. *args kabul eden bir işlev var ve Python stdlib belgelerinin kullandığı biraz daha güzel funcname(arg1[, arg2[, ...]]) stilini göstermek için belgeleri geçersiz kılmak istiyorum.

belirli bir işlev için AutoDoc çıkışını geçersiz kılmak mümkün mü?

Answer 1

O autofunction kullanarak bir imza geçersiz kılmak mümkündür:

.. automodule:: yourmodule 
    :members: 
    :exclude-members: funcname 

.. autofunction:: funcname(arg1[, arg2[, ...]]) 

Ancak geçersiz kılınmış imzası ile fonksiyon automodule ile çekilmiş diğer işlevlerle sıralanır. Her fonksiyon için açık autofunction direktifleri kullanarak o etrafında çalışır:

.. autofunction:: firstfunc 

.. autofunction:: funcname(arg1[, arg2[, ...]]) 

.. autofunction:: thirdfunc 

ilavesi

Ayrıca docstringe ekleyebilirsiniz: yerine function kullanın

.. autofunction:: funcname(arg1[, arg2[, ...]]) 

    Extra documentation here. 

imza ve docstring'ini hem geçersiz kılmak için autofunction.

Eklenen 2

imza da işlev docstringe ilk satırı olan bir imzası bulunan geçersiz kılınabilir. Detaylar için bakınız this answer. "Addition2" için