«python-sphinx» etiketlenmiş sorular

RST'den nefret ediyorum ama sfenks seviyorum. Sfenks'in reStructuredText yerine markdown okumasının bir yolu var mı?

212 python  markdown  python-sphinx 

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 

Bir reST / Sphinx sayfasına, aynı dokümantasyon setindeki başka bir sayfadaki bir alt başlığa veya bağlantıya nasıl çapraz referans eklenir?

110 python-sphinx  restructuredtext 

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 

Kapalı . Bu soruya daha çok odaklanılması gerekiyor . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek mi istiyorsunuz? Soruyu yalnızca bu gönderiyi düzenleyerek tek bir soruna odaklanacak şekilde güncelleyin . 2 yıl önce kapalı . Bu soruyu geliştirin Doxygen'in C veya PHP kodunun belgelerini oluşturmasını seviyorum. Yaklaşan bir Python …

94 python  documentation  python-sphinx  doxygen  docstring 

Aşağıdaki kodu kullanarak uygun şekilde iç içe geçmiş bir liste oluşturmaya çalışıyorum ( Sphinx ve docutils belgelerini takip ederek ): 1. X a. U b. V c. W 2. Y 3. Z Bunun iki OLsaniye ile sonuçlanmasını bekliyorum ama bunun yerine aşağıdaki çıktıyı alıyorum: <ol class="arabic simple"> <li>X</li> </ol> <blockquote> …

91 markup  restructuredtext  python-sphinx 

Python dışı bir projeyi belgelemek için Sphinx kullanıyorum. ./docHer alt modülde, submodule_name.rstbu modülü belgelemek için dosyalar içeren klasörleri dağıtmak istiyorum . Daha sonra tüm tasarım için bir özellik oluşturmak için bu dosyaları ana hiyerarşiye çekmek istiyorum. Yani: Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst …

91 python  python-sphinx  symlink  toctree 

Sınıfımdaki bir yönteme, aynı sınıftaki başka bir yöntemin docstring'inden bir bağlantı eklemek istiyorum. Bağlantının sphinx'te ve tercihen Spyder ve diğer Python IDE'lerinde çalışmasını istiyorum. Birkaç seçenek denedim ve işe yarayan bir tane buldum, ancak bu külfetli. Aşağıdaki yapıyı varsayalım mymodule.py def class MyClass(): def foo(self): print 'foo' def bar(self): """This …

90 python  python-sphinx  spyder 

Sphinx dokümanlarının read-the-docs'ta derlemesi aşağıdaki hatayla başarısız olur (aşağıdaki tam günlük): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) Yanlış bir şey mi yaptım yoksa bu dokümanlar için bir hata mı? Sfenks belgelerinin yerel bir yapısı iyi çalışır. Dokümanları okurken hata günlüğünü tamamla: Read the Docs build information Build id: …

25 python  python-sphinx  read-the-docs 

Lütfen dosyayı indirip simple.7zsfenksinize yükleyin, burada tarif ettiğim sorunları çoğaltın, yeniden oluşturmak için çalıştırabilirsiniz: make clean make html sorunları yeniden oluşturmak için sfenksinize indirin ve yükleyin İçinde iki makale var sample/source, içerik aynı, sadece başlık başlık. cd sample ls source |grep "for-loop" What does "_" in Python mean in a …

14 python  python-sphinx