Sphinx adalah alat yang memudahkan untuk membuat dokumentasi cerdas dan indah untuk proyek-proyek Python (atau dokumen lain yang terdiri dari beberapa sumber reStructuredText), yang ditulis oleh Georg Brandl. Proyek ini awalnya diciptakan untuk menerjemahkan dokumentasi Python baru, tapi sekarang telah dibersihkan dengan harapan bahwa itu akan berguna untuk proyek-proyek lain.
Sphinx menggunakan reStructuredText sebagai bahasa markup, dan banyak kekuatan berasal dari kekuatan dan keterusterangan dari reStructuredText dan parsing dan menerjemahkan suite, yang Docutils.
Meskipun masih dalam pengembangan konstan, fitur berikut sudah ada, bekerja dengan baik dan dapat dilihat "beraksi" di dokumentasi Python:
& Nbsp; * Format Output: HTML (termasuk Windows HTML Help) dan LaTeX, untuk versi PDF cetak
& Nbsp; * ekstensif referensi silang: markup semantik dan link otomatis untuk fungsi, kelas, istilah glossary dan potongan serupa informasi
& Nbsp; * Struktur hirarkis: mudah definisi pohon dokumen, dengan link otomatis ke saudara, orang tua dan anak-anak
& Nbsp; * indeks Otomatis: indeks umum serta indeks modul
& Nbsp; * Kode penanganan: menyoroti otomatis menggunakan stabilo Pygments
& Nbsp; * Berbagai ekstensi yang tersedia, misalnya . untuk pengujian otomatis potongan dan penyertaan docstrings tepat diformat
Persyaratan :
- Python
Komentar tidak ditemukan