2015-01-17 16 views
21

İki belgeli global özel üyeye sahip bir modülüm var.Dokümanlar Özel üyeler için autodoc belgelerini de okuyor musunuz?

Sfenks'i yerel olarak çalıştırmak, belgelerini içeren belgeleri oluşturur, ancak Dokümanların okunmadığını okuyun. Bunun yerine yerleşik türün belgelerini kullanır.

Her iki stili de denedim: #: ve tanımdan sonra docstring. Autodoc'un belgelerini birçok kez okudum ve Read the Docs entry on it. Ne okuduğumu anlayamıyorum, çünkü Dokümanları Oku'da herhangi bir yapı hatası göremiyorum.

Herhangi bir fikrin var mı? Ben doğru zamanda bir direktif var Hatırlarsanız

Eğer NumPy veya Google tarzı Docstringler işlemek için Napolyon uzantısını kullanan durumda
+0

Doküman oluşturmak için kullandığınız komutun tamamını gösterebilir misiniz? –

+0

https://readthedocs.org/projects/argf/builds/3296530/: 'python /home/docs/checkouts/readthedocs.org/user_builds/argf/envs/latest/bin/sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D dili = tr. _build/html' –

+0

Buraya gelip, "#:" ile hemen hemen "sphynx" de yaptığınız gibi söyleyecektim ... ama bunu denediniz gibi görünüyor. İyi bir cevap aldığınızı umuyoruz bir +1 :) –

cevap

1

, kendi conf.py

http://sphinx-doc.org/ext/napoleon.html?highlight=special#confval-napoleon_include_special_with_doc

bunun için bir yapılandırma bayrağı ayarlayabilirsiniz AutoDoc için:

http://sphinx-doc.org/ext/autodoc.html?highlight=member#event-autodoc-skip-member

Eğer üye docs dahil edilecek ve hangi ince taneli seçim var bu yöntemi uygulayarak değil.

+0

https://stackoverflow.com/questions/15903577/include-specific-special-methods-in-sphinx adresine bakın. – marscher

İlgili konular