Ini dapat membuat dokumen HTML di daftar pembuatan yang Anda pilih. Ini dapat dilakukan dengan menjalankan merek pembuat Anda. Di dalam dokumen asal Sphinx, Anda dapat memanfaatkan fitur-fitur standarreStructuredText.
- Sphinxdoc/sphinx-latexpdf menyertakan bundel TeXLive.
- Jangan gunakan __all__ setiap kali memeriksa modul baru sehingga Anda dapat mendokumentasikannya.
- Bahwa itu layak mengendalikan genetika dokumen baru. Ketika ditetapkan ke Asli, dokumen baru untuk jenis atau tipnya sendiri, jika tidak jelas-jelas awam, diturunkan dari ibu.
- Itu akan terjadi selama opsi genetika terbaru tersedia.
Pengaturan¶
Diproduksi ketika autodoc memberikan pemahaman dan Anda dapat memproses dokumen yang baik. Yang layak untuk mengontrol genetika docstrings baru. Jika diatur ke Real docstring baru untuk kategori atau tip, jika tidak secara eksplisit ditempatkan, cobalah diwariskan dari orang tua. Ini digunakan untuk tetap mengetik alias tidak dianalisis dalam dokumen. Karakteristik atau tindakan yang kelebihan beban tidak akan menyertakan petunjuk ketik dalam deskripsi karena tidak praktis untuk secara jujur menggambarkan semua kemungkinan kelebihan beban sementara daftar variabelnya sangat bagus.
buruh pelabuhan¶
Daftar akar dari baris Sphinx yang bagus dari sumber dokumen pesan teks biasa disebut daftar penyebab utama. Saat Anda juga berada di sini, https://1xslot-casino.net/id/ Anda dapat mengunjungi publikasi instalasi dengan pengenalan baru sehingga Anda dapat melihat struktur markup default yang digunakan oleh Sphinx, reStructuredText. Tujuan dari file ini adalah memberi Anda preferensi instan tentang apa itu Sphinx dan bagaimana Anda dapat menggunakannya.
- Anda akan menemukan beberapa ekstensi yang disediakan karena halaman-halaman dari sphinx-contriborganization.
- Membuat file otomatis untuk memiliki anggota khusus dari kelas prospektif, juga dikenal sebagai label ‘dunder’. Ini mencakup semua label tertutup yang memiliki penekanan ganda, age.grams.
- Dan membuat tautan yang bagus ke arahan envvar gratis yang baru, jika ini dapat diperoleh.
Objek referensi silang¶
Nama file baru yang diberikan biasanya relatif terhadap direktori baru tempat file sumber modern berada, namun jika natural (dimulai dengan /), diambil sesuai dengan direktori asal utama. Tautan ke dokumen yang diinginkan; label file baru akan menjadi kerabat dekat, jika tidak, jalur absolut dan selalu peka terhadap situasi, juga untuk Windows. Ini hanya muncul ketika pilihan baru yang memberi tahu Anda tentang keturunan sedang dipertimbangkan. Sudut sebenarnya adalah ringkasan kategori yang dapat diubah oleh pengendali nuansa untuk mengubah apa yang ditempatkan Sphinx pada produktivitas Anda. Jika tidak ada baris yang cocok, dokumen baru yang dihasilkan kosong, oleh karena itu tidak ada perubahan yang akan dilakukan kecuali keepempty benar.
Nama domain adalah beberapa tipe objek yang dimilikinya, dirinci dengan markup untuk membantu membuat dan Anda akan mereferensikan deskripsinya. Tentu saja ekspektasi utama Sphinx adalah mendokumentasikan berbagai hal dengan mudah (dalam pengertian umum) di hampir semua domain. Namun, program sphinx-quickstart menghadirkan Makefile yang luar biasa dan Anda dapat membuat.bat yang membuat hidup Anda lebih mudah.
Outlines adalah daftar rantai yang luar biasa – baris baru dari dokumen yang telah diproses – yang memiliki pengalaman penangan yang dapat diatur secara khusus untuk mengubah apa yang Sphinx tinggalkan terhadap produktivitas. Ini dapat dinonaktifkan jika kata sandi sumber Anda tidak cocok dengan komentar tipe, misalnya jika ini hanya menggunakan bentuk anotasi atau tidak menyukai saran apa pun. Komentar jauh dari kode asal untuk melengkapi jenis anotasi yang dihancurkan, jika Asli.
Jangan gunakan __all__ saat memeriksa modul terbaru untuk membantu Anda mengajukan. Alternatifnya, autodoc juga memahami dokumen yang bagus tentang rentang baru saat ini. Jika Anda menginginkan NumPy jika tidak, dokumen tata letak Yahoo melalui reStructuredText, Anda juga dapat membiarkan ekstensi napoleon. napoleon adalah praprosesor yang akan membuat Anda mengubah dokumen menjadi memperbaiki reStructuredText sebelum melakukan prosedur autodoc. Anda akan membuat koleksi perangkat lunak fiksi untuk menghasilkan perawatan makanan sewenang-wenang yang akan membantu sekaligus menjadi panduan hebat sepanjang proses, dengan tujuan mencatatnya dengan aman. Biasanya rencananya disebut python3-sphinx, python-sphinx jika tidak sphinx. Buatlah referensi ke halaman manual thesphinx-build untuk mengetahui lebih lanjut.