Sphinx

Ketika dibuat untuk pertama kalinya, itu tujuan utama adalah untuk melayani sebagai generator dokumentasi untuk Python 's kode sendiri.
Sejak itu, proyek ini telah mencapai status kultus di dunia pembangunan, menjadi salah satu pengaruh yang paling dirujuk dalam generator dokumentasi paling otomatis sekitar, terlepas dari bahasa.
Hari ini, selain hanya Python, Sphinx juga dapat digunakan dengan kode C dan C ++ juga.

Apa yang baru dalam rilis ini:

• Add arahan kenyamanan dan peran untuk domain C ++: direktif `` cpp: var`` sebagai alias untuk `` cpp: member``, peran ``: cpp: var`` sebagai alias untuk ``: cpp: anggota ``, dan peran `any` untuk cross-referensi untuk setiap C ++ declaraction.
• : confval: `nilai config source_suffix` sekarang bisa daftar beberapa akhiran
.
• Tambahkan kemampuan untuk menentukan sumber parser oleh sumber akhiran dengan: confval:. `Nilai config source_parsers`
• Sebuah pembangun baru, AppleHelpBuilder, telah ditambahkan yang membangun Apel Bantuan Buku.

Apa yang baru di versi 1.2.3 / 1.3b3:

• Ditambahkan `` sphinx.version_info`` tuple untuk memeriksa program dari versi Sphinx.

Apa yang baru di versi 1.1.3:

• Fixed crash dengan beberapa pengaturan: confval:. `Modindex_common_prefix`
• Tetap penanganan `` `` -D`` dan pilihan -A`` di Python 3.
• Diakui dan memperingatkan tentang toctrees melingkar, bukannya berlari ke kesalahan rekursi.
• Kembalikan kompatibilitas dengan docutils batang.
• Tetap htmlhelp entri indeks link lagi.
• inheritance_diagram tetap menaikkan kesalahan atribut pada builtin.
• crash Tetap saat meletakkan komentar atau istilah tunggal dalam glosarium.
• Tetap bantuan HTML bahasa / encoding pemetaan untuk semua Sphinx bahasa yang didukung.

Apa yang baru di versi 1.1:

• Fitur menambahkan:
• dukungan 3.x Ditambahkan Python
.
• pembangun baru dan subsistem.
• perubahan kompatibel:
• : pertama: dir: `py: direktif module` tidak output` `platform`` nilai pilihan lagi. (Ini adalah satu-satunya hal yang direktif melakukan output, dan karena itu cukup konsisten.)
• dukungan Dihapus untuk versi ketergantungan tua.
• Lokal Baru:
• Ditambahkan lokal Swedia.
• Ditambahkan Iran lokal.
• Ditambahkan Latvia lokal.
• Ditambahkan Nepal lokal.
• Ditambahkan lokal Korea.
• Ditambahkan Estonia lokal.

Apa yang baru di versi 1.0.8:

• tracebacks Fix untuk AttributeErrors generasi Autosummary.
• Memperbaiki `` peran abbr`` saat singkatan memiliki baris di dalamnya.
• Perbaiki link ke hasil dengan jenis objek kustom pencarian.
• nomor baris Fix dilaporkan dalam peringatan tentang referensi terdefinisi.
• Fix C ++ definisi array dan argumen template yang tidak mengetik nama
.
• Izinkan catatan kaki di bagian header dalam output LaTeX.
• Izinkan kata kunci untuk dihubungkan melalui intersphinx.
• Izinkan karakter Unicode dalam daftar produksi nama Token.
• Add pengunjung dummy untuk node graphviz untuk teks dan manusia.
• duplikasi file gambar Fix bug.
• parsing Fix beberapa tanda tangan di domain C ++.


• Abaikan file kunci Emacs ketika mencari file sumber.
• Izinkan ekstensi .pyw untuk modul diimpor di autodoc.
• Gunakan `` $ (MAKE) `` di quickstart dihasilkan Makefiles.
• Membuat lebar kotak pencarian sidebar konsisten dalam browser.
• Fix jarak angka berpusat output HTML.
• Aman mengkodekan pesan SphinxError saat mencetak mereka untuk sys.stderr.
• Fix LaTeX kesalahan output dengan dokumen tanpa bagian tapi link target.
• Benar mengobati built-in metode deskriptor sebagai metode dalam autodoc.
• Hentikan monkeypatching modul textwrap Python.
• Viewcode sekarang bekerja dengan benar dengan file sumber yang memiliki encoding non-ASCII.
• Menghormati `` opsi bendera noindex`` di py:. Arahan modul
• IndexErrors Fix ketika termasuk nonexisting baris dengan: pertama: dir:. `Literalinclude`

String
• fungsi Menghormati kustom / metode parameter pemisah.
• Fix JS ketidakcocokan dengan jQuery & gt;. = 1,5
• Perbaiki encoding ganda dilakukan saat menulis htmlhelp .hhk file.
• Jangan berlaku smartypants di diurai-literal blok.
• domain C ++ sekarang mendukung definisi array.

Apa yang baru di versi 1.0.6:

• Fix traceback Python domain untuk target referensi silang kosong.
• Perbaiki masalah tampilan blok literal pada Chrome browser.
• Dukungan menyortir berbagai terbatas karakter beraksen dalam indeks umum dan glossary.
• Coba decoding `` `` -D`` dan -A`` argumen baris perintah dengan encoding disukai lokal ini.
• Perhatikan: confval:. `Locale_dirs` ketika mencari JS terjemahan berkas
• Tambahkan kode khusus untuk dukungan yang lebih baik dari dokumen Jepang di pembangun LaTeX.
• Regresi # 77: Jika hanya ada satu parameter yang diberikan dengan ``: param:. `` Markup, daftar peluru kini ditekan lagi
• Perbaiki hilang paragraf istirahat dalam output LaTeX dalam situasi tertentu.
• Keluarkan yang `` acara autodoc-proses-docstring`` bahkan untuk objek tanpa docstring sehingga dapat menambahkan konten.
• Dalam pembangun LaTeX, tidak hanya blok literal membutuhkan penanganan tabel yang berbeda, tetapi juga cukup elemen blok daftar-seperti lainnya beberapa.
• tracebacks Fix di ekstensi viewcode untuk objek Python yang tidak memiliki tanda tangan yang valid.
• Perbaiki reportings aneh nomor baris untuk peringatan yang dihasilkan dari autodoc-termasuk docstrings, karena perilaku yang berbeda tergantung pada versi docutils.
• Beberapa perbaikan ke ++ domain C.

Apa yang baru di versi 1.0.5:

• Tambahkan gaya CSS yang diperlukan oleh docutils 0,7 untuk gambar selaras dan angka.
• Dalam Makefile yang dihasilkan oleh keluaran LaTeX, tidak menghapus file pdf di bersih; mereka mungkin diperlukan gambar.
• keluaran Fix LaTeX dihasilkan untuk blok baris.
• Izinkan `` .pyw`` sebagai ekstensi file sumber.

Apa yang baru di versi 1.0.4:

• Buka persediaan intersphinx dalam mode biner pada Windows, sejak versi 2 berisi data zlib-terkompresi.
• Izinkan memberikan URI non-lokal untuk file JavaScript, misalnya dalam ekstensi JSMath
.
• traceback Fix ketika `` intersphinx_mapping`` kosong.

Apa yang baru di versi 1.0.3:

• Perbaiki intern vs perbedaan link untuk link yang berasal dari docutils meja-dari-isi eksternal.
• Memperbaiki `` pilihan maxdepth`` untuk `` toctree () `` Template callable bila digunakan dengan `` runtuhnya = True``
.
• Fix kecelakaan parsing daftar argumen Python mengandung kurung dalam string literal.
• regresi Fix ketika membangun LaTeX docs dengan tokoh-tokoh yang tidak memiliki keterangan.
• Fix diagram warisan untuk kelas yang tidak picklable.
• Mengenalkan warna latar belakang yang terpisah untuk tombol runtuhnya sidebar, sehingga lebih mudah untuk melihat.
• Perbaiki tata letak bug kecil di beberapa
built-in tema.

Apa yang baru di versi 1.0.2:

• Perbaiki referensi silang ke objek jenis ditambah dengan: func:. `~ .Sphinx.add_object_type` Fungsi API
• Fix penanganan jenis bidang doc untuk jenis direktif yang berbeda.
• Izinkan melanggar tanda tangan panjang, dilanjutkan dengan baris reaksi-melarikan diri.
• Perbaiki styling yang tidak diinginkan dari C referensi domain (karena bentrokan namespace dengan Pygments gaya).
• Izinkan referensi untuk PEP dan RFC dengan jangkar eksplisit.
• Fix LaTeX referensi angka
.
• Ketika melakukan pencarian non-tepat, pertandingan hanya jenis tertentu objek.
• Terapkan pencarian non-tepat untuk referensi target Python dengan `` .name`` untuk modul juga.
• Fix crash ketika menduplikasi parameter dalam daftar Info bidang.
• Perbaiki pengaturan peran default yang disediakan oleh `` ekstensi oldcmarkup``.
• kecelakaan Fix ketika json-py diinstal, yang menyediakan `` modul json`` tetapi tidak sesuai untuk simplejson.
• Fix penanganan target penamaan di intersphinx.
• penghapusan Fix dari ``! `` Untuk semua peran referensi silang
.

Apa yang baru di versi 1.0.1:

• Perbaiki nama Target dihasilkan untuk objek domain beristirahat; mereka tidak dalam namespace yang sama.
• Add bahasa Bengali.
• Perbaiki bug di parsing nama objek JavaScript.
• Perbaiki membangun dengan SingleHTMLBuilder ketika tidak ada toctree.
• display Fix nama untuk benda yang terkait dengan dengan intersphinx dengan target eksplisit.
• Perbaiki bangunan dengan pembangun JSON.
• hyperrefs Fix di deskripsi objek untuk LaTeX.

Apa yang baru di versi 1.0:

• Umum:
• Ditambahkan "nitpicky" mode yang memancarkan peringatan untuk semua referensi hilang. Hal ini diaktifkan oleh: option: `-n` saklar baris perintah atau: confval:.` Nilai config nitpicky`
• Ditambahkan `` sasaran latexpdf`` di quickstart Makefile.
• Markup:
• : pertama: Peran: `menuselection` dan: pertama: Peran:.` Peran guilabel` sekarang mendukung akselerator ampersand
• New sintaks bidang doc lebih kompak sekarang diakui: ``: nama jenis param. Description``
• Ditambahkan `` opsi tab-width`` ke: pertama: dir:. `Direktif literalinclude`
• Ditambahkan `` pilihan titlesonly`` ke: pertama: dir:. `Toctree` direktif
• Ditambahkan `` `` prepend`` dan pilihan append`` ke: pertama: dir:. `Direktif literalinclude`
• Semua metadata docinfo sekarang dimasukkan ke dalam metadata dokumen, bukan hanya penulis.
• : pertama: Peran: `peran ref` sekarang dapat juga referensi tabel dengan caption
.
• : pertama: dir:. `Direktif include` sekarang mendukung path absolut, yang diartikan sebagai relatif terhadap direktori source
• Dalam domain Python, referensi seperti ``: func:. `.name``` Sekarang mencari untuk pencocokan nama dengan awalan apapun jika tidak ada pertandingan langsung ditemukan
• Konfigurasi:
• Added: confval:. `Rst_prolog` nilai config
• Added: confval:. `Nilai html_secnumber_suffix` config untuk mengontrol bagian nomor format
• Added: confval:. `Nilai html_compact_lists` config untuk mengontrol daftar kompak docutils 'fitur
• : confval: `nilai config html_sidebars` sekarang dapat berisi pola sebagai kunci, dan nilai-nilai dapat daftar yang secara eksplisit memilih sidebar template harus diberikan. Itu berarti bahwa isi sidebar builtin dapat dimasukkan hanya selektif.
• : confval:. `Html_static_path` sekarang dapat berisi entri file
• Nilai konfigurasi baru yang universal: confval: `exclude_patterns` membuat lama: confval:` unused_docs`,: confval: `exclude_trees` dan: confval:.` Exclude_dirnames` usang
• Added: confval:. `Html_output_encoding` nilai config
• Ditambahkan: confval: `nilai config latex_docclass` dan membuat" twoside "pilihan documentclass overridable oleh" oneside "
.
• Ditambahkan: confval:. `Nilai konfigurasi trim_doctest_flags`, yang benar secara default
• Added: confval:. `Html_show_copyright` nilai config
• Added: confval: `latex_show_pagerefs` dan: confval:.` Nilai config latex_show_urls`
• Perilaku: confval: `html_file_suffix` berubah sedikit: string kosong sekarang berarti" tidak ada akhiran "bukan" akhiran default ", penggunaan` `None`` untuk" akhiran default "
.
• pembangun Baru:
• Ditambahkan pembangun untuk format Epub.
• Ditambahkan pembangun untuk halaman manual.
• Ditambahkan pembangun HTML file tunggal.
• keluaran HTML:

Peran
• Inline sekarang mendapatkan kelas CSS dengan nama mereka, yang memungkinkan gaya untuk menyesuaikan penampilan mereka. Peran domain-spesifik mendapatkan dua kelas, `` `` domain`` dan domain-rolename``.
• Referensi sekarang mendapatkan kelas `` internal`` jika mereka internal untuk keseluruhan proyek, sebagai lawan internal untuk halaman saat ini.
• referensi eksternal dapat ditata berbeda dengan `` pilihan tema externalrefs`` baru untuk tema default.
• Dalam tema default, sidebar bisa eksperimental sekarang dibuat dilipat menggunakan baru `` pilihan tema collapsiblesidebar``.
• Toctrees sekarang dibungkus dalam `` div`` tag dengan kelas `` toctree-wrapper`` dalam output HTML.
• : Data:. `Toctree` callable di template sekarang memiliki` `maxdepth`` argumen kata kunci untuk mengontrol kedalaman pohon yang dihasilkan
• : Data:. `Toctree` callable di template sekarang menerima` `titles_only`` argumen kata kunci
• Ditambahkan `` block htmltitle`` di layout template.
• Dalam pencarian JavaScript, memungkinkan mencari nama objek termasuk nama modul, seperti `` sys.argv``.
• Ditambahkan tema baru `` haiku``, terinspirasi oleh buku petunjuk Haiku OS.
• Ditambahkan baru tema `` nature``.
• Ditambahkan tema baru `` agogo``, diciptakan oleh Andi Albrecht.
• Ditambahkan tema baru `` scrolls``, diciptakan oleh Armin Ronacher.
• Ditambahkan `` pilihan tema visitedlinkcolor`` untuk tema default.
• Peningkatan respon dari halaman pencarian dengan memuat indeks thesearch asynchronous.
• Ekstensi API:
• Ditambahkan: acara:. `Html-collect-pages`
• Added: confval: `nilai config needs_sphinx` dan: met:.` ~ Metode sphinx.application.Sphinx.require_sphinx` aplikasi API
• Added: met:. ~ Metode `sphinx.application.Sphinx.add_stylesheet` aplikasi API
• Ekstensi:
• Ditambahkan: mod: `~ ekstensi sphinx.ext.viewcode`
.
• Ditambahkan: mod: `~ ekstensi sphinx.ext.extlinks`
.
• Ditambahkan dukungan untuk sumber pemesanan anggota di autodoc, dengan `` autodoc_member_order = 'bysource'``.
• Added: confval:. `Autodoc_default_flags` nilai konfigurasi, yang dapat digunakan untuk memilih bendera default untuk semua arahan autodoc
• Ditambahkan cara untuk intersphinx untuk merujuk label bernama dalam proyek-proyek lainnya, dan untuk menentukan proyek yang ingin Anda link ke.
• Autodoc sekarang dapat mendokumentasikan contoh atribut ditugaskan di `` metode __init__``.
• Banyak perbaikan dan perbaikan ke: mod:. `~ Ekstensi sphinx.ext.autosummary`, berkat Pauli Virtanen
• : mod: `~ ekstensi sphinx.ext.graphviz` bisa SVG sekarang keluaran bukan gambar PNG, dikendalikan oleh confval yang:.` Nilai config graphviz_output_format`
• Ditambahkan `` pilihan alt`` ke: pertama: dir:. `Arahan ekstensi graphviz`
• Ditambahkan `` argumen exclude`` ke: func:. `.autodoc.between`
• Terjemahan:
• Ditambahkan terjemahan Kroasia, berkat Bojan Mihelac.
• Ditambahkan terjemahan Turki, berkat Firat Ozgul.
• terjemahan Ditambahkan Catalan, berkat Pau Fernandez
.
• Ditambahkan disederhanakan terjemahan bahasa China.
• Ditambahkan terjemahan Denmark, berkat Hjorth Larsen.
• Ditambahkan terjemahan Lithuania, berkat Dalius Dobravolskas.

Apa yang baru dalam versi 1.0b1:

• Dukungan untuk domain telah ditambahkan. Sebuah domain adalah kumpulan arahan dan peran yang semua menggambarkan benda milik bersama, misalnya unsur bahasa pemrograman. Beberapa domain builtin disediakan: - Python - C - C ++ - JavaScript - reStructuredText
• markup tua untuk mendefinisikan dan menghubungkan ke C arahan tidak akan bekerja lagi tanpa mengaktifkan `` ekstensi oldcmarkup``.
• dukungan Dihapus untuk versi ketergantungan tua.
• Dihapus unsur usang.

Apa yang baru di versi 0.6.5:

• Dalam autodoc, memperbaiki kelalaian dari beberapa anggota modul eksplisit didokumentasikan menggunakan komentar dokumentasi.
• Fix tanam scroll bar sidebar dengan `` pilihan stickysidebar`` dari tema default.
• Selalu menghasilkan baris UNIX dalam Makefile quickstart.
• Perbaiki berjalan dengan `` -C`` bawah Windows.
• Dalam autodoc, memungkinkan menyesuaikan tanda tangan dari obyek mana mekanisme built-in gagal.
• keluaran Fix untuk daftar dicacah dengan nilai awal di LaTeX.
• Membuat `` start-after`` dan `` pilihan akhir-before`` ke `` kerja direktif literalinclude`` benar jika tidak digunakan bersama-sama.
• Fix generasi link dalam pembangun LaTeX.

Apa yang baru di versi 0.6.4:

• Peningkatan penanganan string non-Unicode di konfigurasi.
• OSErrors Tangkap terjadi saat memanggil graphviz dengan argumen itu tidak mengerti.
• Kembalikan kompatibilitas dengan Pygments & gt;. = 1.2
• Perbaiki melarikan diri dari target hyperref output LaTeX.
• link Fix dihasilkan oleh ``: doc:. `` Peran untuk output LaTeX
• Kumpulkan todo node setelah seluruh dokumen telah dibaca; ini memungkinkan menempatkan referensi substitusi todo item.
• Jangan mengabaikan sebuah `` nilai config today`` eksplisit dalam LaTeX membangun.
• `` teks alt`` diagram warisan sekarang jauh lebih bersih.
• Abaikan gambar di judul bagian saat membuat keterangan Link.
• Pesan Dukungan pengecualian dalam `` blok testoutput`` dari `` ekstensi doctest``.
• blok Line ditata dengan baik dalam output HTML.
• Made `` locale_dirs`` kerja nilai konfigurasi lagi.
• `` nilai html_context`` diberikan pada baris perintah melalui `` -A`` tidak harus mengesampingkan nilai-nilai lain yang diberikan dalam conf.py.
• Perbaiki bug mencegah membangun kembali tambahan untuk `` pembangun dirhtml``.
• Memperbaiki mangling kutipan dalam beberapa blok literal.
• jalan Fix untuk indeks pencarian untuk `` pembangun dirhtml``.
• Perbaiki masalah kompatibilitas Jython: membuat ketergantungan pada `` modul parser`` opsional
.
• Dalam autodoc, menangkap semua kesalahan yang terjadi pada modul impor, bukan hanya `` ImportError``
.
• Perbaiki penanganan non-data, tetapi non-metode deskriptor di autodoc.
• Saat menyalin berkas kali, mengabaikan OSErrors dibesarkan oleh `` os.utime () ``.

Persyaratan :

• Pygments 1.2 atau lebih tinggi
• Jinja 2.3 atau lebih tinggi
• Docutils 0/7 atau lebih tinggi