Saya mencoba menggunakan Sphinx untuk mendokumentasikan proyek 5.000+ line dengan Python. Ini memiliki sekitar 7 modul dasar. Sejauh yang saya tahu, Untuk menggunakan autodoc saya perlu menulis kode seperti ini untuk setiap file dalam proyek saya: .. automodule:: mods.set.tests :members:...
Sphinx tidak membuat dokumen untuk __init __ (self) secara default. Saya telah mencoba yang berikut ini: .. automodule:: mymodule :members: dan ..autoclass:: MyClass :members: Di conf.py, pengaturan berikut hanya menambahkan docstring __init __ (self) ke kelas docstring ( dokumentasi...
Saya mencoba untuk memulai dengan Sphinx dan sepertinya mengalami masalah tanpa henti. Perintah: docs/sphinx-quickstart Saya menjawab semua pertanyaan dan semuanya bekerja dengan baik. Perintah: docs/ls Semuanya terlihat normal. Hasil:build Makefile source Perintah: sphinx-build -d...
Saya menggunakan sphinx dan plugin autodoc untuk menghasilkan dokumentasi API untuk modul Python saya. Meskipun saya dapat melihat cara mendokumentasikan parameter tertentu dengan baik, saya tidak dapat menemukan contoh cara mendokumentasikan **kwargsparameter. Adakah yang punya contoh bagus...