sphinx-apidoc - Dalam Talian di Awan

JADUAL:

NAMA

sphinx-apidoc - Alat penjana dokumen API Sphinx

SINOPSIS

sphinx-apidoc [pilihan] -ooutputdir>sourcedir> [nama laluan ...]

DESCRIPTION

sphinx-apidoc ialah alat untuk penjanaan automatik sumber Sphinx yang, menggunakan autodoc
sambungan, dokumenkan keseluruhan pakej dalam gaya dokumentasi API automatik yang lain
alat.

sourcedir mesti menunjuk kepada pakej Python. mana-mana nama laluan yang diberikan adalah laluan untuk dikecualikan
daripada generasi.

AMARAN :
sphinx-apidoc menjana fail sumber yang menggunakan sphinx.ext.autodoc untuk mendokumentasikan semua yang ditemui
modul. Jika mana-mana modul mempunyai kesan sampingan pada import, ini akan dilaksanakan oleh autodoc
apabila binaan sphinx dijalankan.

Jika anda mendokumenkan skrip (berbanding dengan modul perpustakaan), pastikan rutin utamanya
dilindungi oleh a if __nama__ == '__utama__' keadaan.

PILIHAN

-o
Direktori untuk meletakkan fail output. Jika ia tidak wujud, ia dicipta.

-f, - kekuatan
Biasanya, apidoc tidak menulis ganti fail, melainkan pilihan ini diberikan.

-l, --ikut-pautan
Ikuti pautan simbolik.

-n, --lari kering
Jika diberikan, apidoc tidak mencipta sebarang fail.

-s
Akhiran untuk fail sumber yang dijana, lalai ialah pertama.

-d
Kedalaman maksimum untuk fail jadual kandungan yang dijana.

-T, --no-toc
Jangan buat fail jadual kandungan.

-F, --penuh
Jika diberikan, projek Sphinx penuh dijana (conf.py, Makefile dll) menggunakan
sphinx-mula pantas.

-e, --berpisah
Letakkan setiap fail modul dalam halamannya sendiri.

-E, --tiada tajuk
Jangan buat tajuk untuk modul/pakej

-P, --swasta
Sertakan modul "_private".

Pilihan ini digunakan dengan -F:

-H
Nama projek untuk dimasukkan ke dalam konfigurasi.

-A
Nama pengarang untuk dimasukkan ke dalam konfigurasi.

-V
Versi projek.

-R
Keluaran projek.

Gunakan sphinx-apidoc dalam talian menggunakan perkhidmatan onworks.net