Ini akan membuat dokumen HTML pada indeks hasil yang Anda pilih. Ini dapat dilakukan dengan mencari tahu identitas pembangun seseorang. Di dalam file data asal Sphinx, Anda dapat memanfaatkan fitur standarreStructuredText yang sangat populer.
- Sphinxdoc/sphinx-latexpdf menyertakan bundel TeXLive.
- Jangan gunakan __all__ saat memeriksa modul baru untuk mengajukan.
- Bahwa itu bernilai mengontrol warisan docstring baru. Ketika set ke Asli, docstring baru untuk memiliki kelas atau tindakan, jika tidak ditetapkan secara eksplisit, diturunkan dari orang tua.
- Itu terjadi selama pilihan pengungkapan-keturunan baru sedang dipertimbangkan.
Pengaturan¶
Dipancarkan setiap kali autodoc memberikan kesadaran dan Anda dapat menyimpan dokumen yang bagus. Jadi ada baiknya mengontrol genetika dokumen baru. Ketika himpunan untuk Mengoreksi dokumen baru menjadi tindakan yang berbeda, jika tidak ditetapkan secara eksplisit, sebenarnya diturunkan dari ibu. Biasanya bentuk-bentuknya tetap alias tidak dianalisis dalam dokumen. Fungsi atau tindakan yang dibanjiri tidak akan menggunakan petunjuk ketik dalam deskripsinya karena tidak praktis untuk secara tepat mewakili semua kemungkinan kelebihan beban karena direktori variabelnya sangat bagus.
buruh pelabuhan¶
Daftar akar penawaran file pesan teks sederhana tipe Sphinx disebut direktori sumber. Setelah Anda selesai di sini, Anda dapat mengunjungi publikasi instalasi disertai dengan pengenalan baru sehingga Anda dapat melihat struktur markup default yang digunakan oleh Sphinx, reStructuredText. Tujuan dari file itu adalah memberi Anda preferensi sederhana tentang apa sebenarnya Sphinx dan bagaimana Anda dapat menggunakannya.
- Anda akan menemukan beberapa ekstensi yang disumbangkan dari profil di sphinx-contriborganization.
- Buatlah dokumen otomatis untuk memiliki orang-orang unik di kelas nilai, yang disebut label ‘dunder’. Misalnya semua label yang diapit memiliki penekanan dua kali lipat, usia.
- Dan menghasilkan tautan yang bagus ke arahan envvar gratis yang baru, jika dapat diperoleh.
Hal-hal referensi silang¶
Nama file terbaru yang diberikan bisa relatif terhadap indeks terbaru tempat file sumber saat ini berada, jika absolut (dimulai dengan /), maka dianggap relatif terhadap playfortunacasino .net indeks asal teratas. Tautan ke dokumen yang diperlukan; istilah file baru akan menjadi anggota keluarga, jika tidak, absolutepath yang selalu halus, juga di Window. Ini hanya muncul jika opsi baru untuk memberi tahu Anda tentang keturunan diberikan. Bases adalah daftar grup yang dapat dimodifikasi oleh pengendali pengalaman Anda untuk mengubah apa yang ditetapkan Sphinx pada output. Jika tidak ada kecocokan baris, docstring terbaru berikutnya akan kosong, sangat tidak ada perubahan yang akan dilakukan kecuali keepempty valid.
Situs web adalah sekumpulan tipe objek yang dimilikinya, diisi dengan markup untuk dibuat dan Anda akan mereferensikan deskripsi barang tersebut. Salah satu tujuan utama Sphinx adalah menjauhkan file dari objek (dalam pengalaman standar) di domain mana pun. Namun, skrip sphinx-quickstart membuat Makefile yang bagus dan Anda dapat membuat.bat yang membuat gaya hidup lebih mudah bagi Anda.
Kontur adalah daftar string yang bagus – kontur baru dari dokumen yang Anda proses sendiri – yang dapat disesuaikan oleh penangan untuk meningkatkan efisiensi yang diberikan Sphinx. Ini dinonaktifkan jika kode sumber daya Anda tidak dapat dipusingkan dengan pernyataan tipe, termasuk jika ini hanya menggunakan anotasi tipe atau tidak bermain dengan ide tipe apa pun. Komentar kode asal untuk melengkapi anotasi yang hilang, jika Benar.
Hindari penggunaan __all__ setiap kali menganalisis komponen baru ke file. Sebaliknya, autodoc juga memahami dokumen yang bagus pada baris baru tepat setelah definisi. Jika Anda memerlukan NumPy, jika tidak, Google akan membuat dokumen lebih banyak reStructuredText, Anda dapat membiarkan ekspansi napoleon. napoleon adalah praprosesor yang baik untuk mengubah dokumen menjadi reStructuredText yang tepat sebelum autodoc memprosesnya. Anda akan melakukan kumpulan perangkat lunak fiksi yang hebat untuk menghasilkan perawatan makan malam acak yang akan membantu sebagai panduan sepanjang proses, agar dapat mencatatnya dengan benar. Biasanya bundelnya diberi nama python3-sphinx, python-sphinx sebaliknya sphinx. Lihat halaman web manual pembuat sphinx untuk mempelajari lebih lanjut.