Keberatan diberikan secara pribadi setelah titik dua https://1xslot-casino.net/id/ kali setelah nama arahan. Toctree mencoba arahan reStructuredText yang bagus, sebuah markup yang sangat fleksibel. Mereka menulis direktori sumber luar biasa yang memiliki file conf.py dan root, index.rst.
Pilihan arahan default¶
Kamus yang sangat bagus untuk membuat bentuk alias yang ditentukan pengguna membuat Anda memetakan istilah tipe untuk nama objek yang memenuhi syarat penuh. Nilai mana yang mengontrol gagasan tentang cara menampilkan petunjuk ketik. Hal ini berguna ketika beberapa dependensi luar tidak terpenuhi dalam proses pembuatan dan pemecahan proses pembangunan baru.
Di mana menempatkan ekstensi individual Anda?¶
Dari sekian banyak file Sphinx termasuk file Python yang coba dipublikasikan di Situs. Konfigurasi untuk dokumen dari banyak pemikiran konfigurasi yang tersedia. File baru disimpan di dalam UTF-8 secara otomatis, sedangkan file dinyatakan dengan deklarasi pengkodean di rentang pertama. Untuk menyesuaikan nilai konfigurasi yang tidak ditambahkan secara otomatis pada sphinx-quickstart, cukup tambahkan proyek tambahan. Sebelumnya kami mengatakan bahwa file conf.py baru mengatur bagaimana Sphinx memproses dokumen Anda. Domainuntuk semua nama domain yang ditawarkan selain arahan/posisinya.
Tampilkan tanda tangan baru untuk label kelas. Jika grup tidak memiliki strategi __init__ atau jika dokumen metode __init__ terbaru sebenarnya kosong, namun kelas tersebut memiliki dokumen metode __baru__ yang bagus, maka kelas tersebut akan ditempatkan sebagai alternatif. Dokumen kategori dan metode __init__ digabungkan dan dimasukkan. Hanya docstring klasifikasi yang coba dimasukkan. Sebaiknya pilih artikel apa yang akan dimasukkan ke sistem utama arahan autoclass Anda. Implementasi baru yang berpusat pada kategori sejarah tidak dapat mendukung bentuk alias PEP 695.
Diproduksi setiap kali autodoc harus memilih apakah seorang rekanan dapat disertakan dalam dokumentasi. Jika Benar, perbedaan pendapat bawaan yang baru berdasarkan karakteristiknya mungkin tidak akan dianalisis pada dokumen yang dihasilkan. Meskipun tidak, ini adalah seminar yang biasanya digunakan untuk menempatkan tanda tangan terbaru pada baris pertama dari dokumen fungsi. Dia diterapkan ke semua arahan autodoc dengan segera. Nilai mana yang memilih cara tanda tangan didemonstrasikan untuk kategori yang ditentukan oleh arahan kelas otomatis.
Mendaur ulang tanda tangan dan Anda mungkin memiliki dokumen yang memiliki autodoc¶
Anda masih dapat mengajukan __init__ sedangkan alternatifnya berarti menggunakan metode otomatis atau opsi peserta untuk kelas otomatis. Oleh karena itu, Anda bahkan dapat menggabungkan file otomatis dan Anda dapat mengaitkan file secara otomatis rendah. Secara default, autodoc mencoba mendapatkan anotasi jenis dan nilai variabel terbaru karena introspeksi, menunjukkan bahwa mereka mengikuti identitas yang dapat disesuaikan. Jadi Anda dapat menimpanya, string yang disesuaikan dengan nilai yang dapat disesuaikan mungkin diambil karena perselisihan sehingga Anda dapat membuat anotasi. Jangan membuat daftar masuk ke rekaman yang dapat diubah atau sedang berlangsung. Untuk menjadikan salah satu kemungkinan yang dibahas di bawah ini sebagai default, gunakan kamus autodoc_default_possibilities di dalam conf.py. Beberapa dialek lain sebenarnya ditawarkan di Sphinx untuk memiliki dokumentasi kode panduan, namun mereka memerlukan ekstensi untuk dokumentasi kode otomatis, seperti Inhale.
Pengaturan¶
Ini benar-benar digunakan dalam inti autodoc dalam jangka panjang. Jadi itu menghargai regulasi struktur baru yang tidak berdasarkan tipografi. Alias jenis hanya tersedia jika sistem mengaktifkan elemen PostponedEvaluation from Annotations (PEP 563) melalui dari __future__ importannotations.
Paket Conda¶
Ekstensi mana yang juga dapat mentransfer modul baru yang Anda rekam, dan Anda akan menyajikan file docstrings dengan metode semi-otomatis yang baik. Di mana sourcedir adalah indeks sumber daya, dan outputdir adalah direktori tempat Anda harus meletakkan dokumen berdasarkan. Opsi -M terbaru memilih pembuat; dalam contoh iniSphinx cenderung membuat data HTML. Ada juga banyak yang ditambahkan oleh Sphinx. Misalnya, Anda dapat menambahkan rekomendasi file campuran dengan cara yang ringan (dan ini berfungsi untuk semua model efisiensi) dengan bagian ref. Jadi itu mencirikan dan membantu pesan teks koneksi yang disesuaikan dari sintaks referensi silang umum.
