คำถามติดแท็ก autodoc

ฉันกำลังพยายามใช้สฟิงซ์เพื่อทำเอกสารโครงการแนว 5,000+ ใน Python มันมีประมาณ 7 โมดูลฐาน เท่าที่ฉันรู้เพื่อที่จะใช้ autodoc ฉันจำเป็นต้องเขียนโค้ดเช่นนี้สำหรับแต่ละไฟล์ในโครงการของฉัน: .. automodule:: mods.set.tests :members: :show-inheritance: นี่เป็นวิธีที่น่าเบื่อเกินไปเพราะฉันมีไฟล์มากมาย มันจะง่ายกว่านี้หากฉันสามารถระบุได้ว่าฉันต้องการให้เอกสาร 'mods' เป็นเอกสาร สฟิงซ์สามารถเรียกแพคเกจซ้ำแล้วซ้ำอีกและสร้างหน้าสำหรับแต่ละ submodule มีคุณสมบัติเช่นนี้หรือไม่? ถ้าไม่ใช่ฉันสามารถเขียนสคริปต์เพื่อสร้างไฟล์. rst ทั้งหมด แต่อาจใช้เวลานานมาก

149 python  python-sphinx  autodoc 

ฉันกำลังพยายามเริ่มต้นกับ Sphinx และดูเหมือนจะมีปัญหาอย่างไม่หยุดยั้ง คำสั่ง: docs/sphinx-quickstart ฉันตอบคำถามทั้งหมดและทุกอย่างทำงานได้ดี คำสั่ง: docs/ls ทุกอย่างดูปกติ ผลลัพธ์:build Makefile source คำสั่ง: sphinx-build -d build/doctrees source build/html ดูเหมือนว่าจะได้ผล ฉันสามารถเปิดไฟล์ index.html และเห็น "เปลือก" ของสิ่งที่ฉันต้องการ เมื่อฉันลองใส่ซอร์สโค้ดจริงของฉันเป็นsourceโฟลเดอร์ที่ฉันพบปัญหา คำสั่ง: sphinx-build -d build/doctrees ../ys_utils build/html ผลลัพธ์: Making output directory... Running Sphinx v1.1.3 loading pickled environment... not yet created No builder selected, using default: html …

108 python  python-sphinx  autodoc 

Sphinx ไม่สร้างเอกสารสำหรับ __init __ (self) ตามค่าเริ่มต้น ฉันได้ลองทำสิ่งต่อไปนี้แล้ว: .. automodule:: mymodule :members: และ ..autoclass:: MyClass :members: ใน conf.py การตั้งค่าต่อไปนี้จะต่อท้ายเฉพาะ __init __ (self) docstring เข้ากับ class docstring ( เอกสาร Autodoc ของ Sphinxดูเหมือนจะยอมรับว่านี่เป็นพฤติกรรมที่คาดหวัง แต่ไม่ได้ระบุอะไรเกี่ยวกับปัญหาที่ฉันกำลังพยายามแก้ไข): autoclass_content = 'both'

107 python  python-sphinx  autodoc 

ฉันใช้สฟิงซ์และปลั๊กอิน autodoc เพื่อสร้างเอกสาร API สำหรับโมดูล Python ของฉัน ในขณะที่ฉันสามารถดูวิธีจัดทำเอกสารพารามิเตอร์เฉพาะได้อย่างสวยงาม แต่ฉันไม่พบตัวอย่างวิธีการจัดทำเอกสาร**kwargsพารามิเตอร์ ใครมีตัวอย่างวิธีที่ชัดเจนในการจัดทำเอกสารเหล่านี้บ้าง?

102 python  python-sphinx  autodoc