sphinx-build - Online di Cloud

PROGRAM:

NAMA

sphinx-build - Alat pembuat dokumentasi Sphinx

RINGKASAN

sphinx-membangun [Pilihan]sourcedir>diluar> [nama file ...]

DESKRIPSI

sphinx-membangun menghasilkan dokumentasi dari file di dan menempatkannya di
.

sphinx-membangun mencari /conf.py untuk pengaturan konfigurasi.
sphinx-mulai cepat(1) dapat digunakan untuk menghasilkan file template, termasuk: conf.py.

sphinx-membangun dapat membuat dokumentasi dalam format yang berbeda. Format dipilih oleh
menentukan nama pembuat pada baris perintah; itu default ke HTML. Pembangun juga bisa
melakukan tugas lain yang terkait dengan pemrosesan dokumentasi.

Secara default, semua yang ketinggalan zaman dibangun. Output hanya untuk file yang dipilih dapat
dibangun dengan menentukan nama file individual.

Daftar pembangun yang tersedia:

html pembuatan file HTML. Ini adalah pembuat default.

dirhtml
Pembuatan file HTML dengan setiap file HTML bernama "index.html" secara terpisah
direktori.

html tunggal
Pembuatan file HTML dengan semua konten dalam satu file HTML.

htmlbantuan
Menghasilkan file untuk pembuatan CHM (file bantuan yang dikompilasi).

qthelp Menghasilkan file untuk pembuatan koleksi bantuan Qt.

bantuan pengembangan
Menghasilkan file untuk penampil bantuan Devhelp GNOME.

getah Menghasilkan keluaran LaTeX yang dapat dikompilasi ke dokumen PDF.

pria Menghasilkan halaman manual.

info teks
Menghasilkan keluaran Texinfo yang dapat diproses oleh info make untuk menghasilkan Info
dokumen.

epub Menghasilkan versi ePub e-book dari keluaran HTML.

teks Menghasilkan versi teks biasa dari dokumentasi.

gettext
Menghasilkan katalog pesan Gettext untuk terjemahan konten.

perubahan
Menghasilkan daftar file HTML yang diubah/ditambahkan/tidak digunakan lagi untuk versi saat ini
dari proyek yang didokumentasikan.

cek tautan
Memeriksa integritas semua tautan eksternal di sumber.

acar / json
Menghasilkan file HTML serial untuk digunakan dalam aplikasi web.

xml Menghasilkan file XML asli Docutils.

pseudoxml
Menghasilkan file "pseudo-XML" tercetak cantik yang menampilkan internal
struktur pohon dokumen perantara.

PILIHAN

-b
Pembangun untuk digunakan; default ke html. Lihat daftar lengkap builder di atas.

-a Hasilkan output untuk semua file; tanpa opsi ini hanya keluaran untuk yang baru dan yang diubah
file dihasilkan.

-E Abaikan file yang di-cache, paksa untuk membaca ulang semua file sumber dari disk.

-d
Jalur ke file yang di-cache; default ke /.doctrees.

-j Bangun secara paralel dengan N proses jika memungkinkan.

-c
Temukan file conf.py di jalur yang ditentukan alih-alih .

-C Tentukan bahwa tidak ada file conf.py sama sekali yang akan digunakan. Konfigurasi hanya dapat diatur
dengan opsi -D.

-D
Mengganti pengaturan dari file konfigurasi.

-t
Menetapkan label untuk digunakan dalam blok "hanya".

-A
Berikan nilai ke dalam template HTML (hanya untuk pembuat HTML).

-n Jalankan dalam mode pilih-pilih, peringatkan tentang semua referensi yang hilang.

-v Meningkatkan verbositas (dapat diulang).

-N Mencegah keluaran berwarna.

-q Pengoperasian yang tenang, cukup cetak peringatan dan kesalahan pada stderr.

-Q Pengoperasian yang sangat tenang, jangan mencetak apa pun kecuali kesalahan.

-w
Tulis peringatan dan kesalahan ke dalam file yang diberikan, selain stderr.

-W Ubah peringatan menjadi kesalahan.

-T Tampilkan traceback penuh pada pengecualian.

-P Jalankan Pdb dengan pengecualian.

Gunakan sphinx-build online menggunakan layanan onworks.net