«autodoc» etiketlenmiş sorular

Python'da 5.000'den fazla satırlık bir projeyi belgelemek için Sphinx'i kullanmaya çalışıyorum. Yaklaşık 7 temel modüle sahiptir. Bildiğim kadarıyla autodoc'u kullanmak için projemdeki her dosya için şu şekilde kod yazmam gerekiyor: .. automodule:: mods.set.tests :members: :show-inheritance: Bu çok sıkıcı çünkü birçok dosyam var. 'Mods' paketinin belgelenmesini istediğimi belirtebilseydim çok daha kolay …

153 python  python-sphinx  autodoc 

Sphinx varsayılan olarak __init __ (self) için doküman oluşturmaz. Aşağıdakileri denedim: .. automodule:: mymodule :members: ve ..autoclass:: MyClass :members: Conf.py'de, aşağıdakinin ayarlanması __init __ (self) docstring'i sınıf docstring'e ekler ( Sphinx autodoc dokümantasyonu bunun beklenen davranış olduğunu kabul ediyor gibi görünüyor, ancak çözmeye çalıştığım problemle ilgili hiçbir şey belirtmiyor): autoclass_content …

108 python  python-sphinx  autodoc 

Sphinx'e başlamaya çalışıyorum ve acımasız problemlerim var gibi görünüyor. Komut: docs/sphinx-quickstart Tüm soruları cevaplıyorum ve her şey yolunda gidiyor. Komut: docs/ls Her şey normal görünüyor. Sonuç:build Makefile source Komut: sphinx-build -d build/doctrees source build/html İşe yarıyor gibi görünüyor. İndex.html dosyasını açabildim ve istediğim şeyin "kabuğunu" görebildim. Asıl kaynak kodumu sourcesorunlarla …

104 python  python-sphinx  autodoc 

Python modüllerim için API dokümantasyonu oluşturmak için sphinx ve autodoc eklentisini kullanıyorum . Belirli parametreleri nasıl güzel bir şekilde belgelendireceğimi görsem de, bir **kwargsparametrenin nasıl belgeleneceğine dair bir örnek bulamıyorum . Bunları belgelemek için iyi bir örnek olan var mı?

102 python  python-sphinx  autodoc