* yalnızca * Sfenks belgelerinde docstring gösteriliyor

Question

Sphinx, belgenin bir yöntemini belgelerden ayıklayıp belgelere yerleştiren automethod adlı bir özelliğe sahiptir. Ancak bu sadece dokuyu değil, aynı zamanda yöntem imzasını da (isim + argümanları) içerir. 'u yalnızca belgelerine nasıl yerleştiririm (yöntem imzası hariç)?

ref: http://sphinx.pocoo.org/ext/autodoc.html

Answer 1

Bence ne aradığınız geçerli:

from sphinx.ext import autodoc 

class DocsonlyMethodDocumenter(autodoc.MethodDocumenter): 
    def format_args(self): 
    return None 

autodoc.add_documenter(DocsonlyMethodDocumenter) 

the current sources başına bu (add_documenter eski sürümleri bu tür geçersiz kılmaları yasakladı yöntemleri belgeleyen sorumludur hangi sınıf geçersiz kılma izin vermelidir, ama şimdi açıkça izin verilir). format_args geri dönüşü Yok, tabiki, "imzayla uğraşmayın" demek için autodoc numaralı belgede belgelenmiş yoldur.

Bu görevin bu görevi yerine getirmek için temiz, mimari bir yol olduğunu düşünüyorum ve bu nedenle, maymun adaylık alternatiflerine tercih edilebilir. sphinx'un bazı eski sürümleriyle yaşamak istiyorsanız, gerçekten de, eğer mevcut dağıtımınıza uygun bir durumda daha iyi bir yaklaşım olarak sphinx'u daha iyi bir yaklaşım olarak güncellemenizi tavsiye etsem de (autodoc.MethodDocumenter.format_args=lambda _:None - eek! -) maymunpatch'e ihtiyacınız olabilir.