Menerjemahkan dokumentasi menggunakan Sphinx

Sphinx adalah alat untuk membuat dokumentasi yang bagus. Sphinx menggunakan sintaksis reStructuredText sederhana dan dapat menghasilkan keluaran dalam banyak format. Jika Anda ingin melihat contohnya, dokumentasi ini juga dibuat dengan menggunakan Sphinx. Pendamping yang sangat berguna untuk menggunakan Sphinx adalah layanan Read the Docs, yang akan membuat dan mempublikasikan dokumentasi Anda secara gratis.

Saya tidak akan fokus menulis dokumentasi itu sendiri. Jika Anda memerlukan panduan, ikuti saja petunjuk di situs web Sphinx. Setelah dokumentasi Anda siap, menerjemahkannya cukup mudah karena Sphinx sudah mendukungnya dan dijelaskan dengan cukup baik dalam Internationalization mereka. Prosesnya hanya perlu beberapa direktif konfigurasi dan pemanggilan alat sphinx-intl.

Jika Anda menggunakan layanan Read the Docs, Anda dapat mulai membuat dokumentasi terjemahan di Read the Docs. Localization and Internationalization mereka mencakup hampir semua yang Anda butuhkan - membuat proyek lain, mengatur bahasanya, dan menautkannya dari proyek utama sebagai terjemahan.

Sekarang yang Anda butuhkan hanyalah menerjemahkan konten dokumentasi. Sphinx menghasilkan berkas PO untuk setiap direktori atau berkas tingkat atas, yang mana dapat menghasilkan cukup banyak berkas untuk diterjemahkan (tergantung pada pengaturan gettext_compact). Anda dapat mengimpor index.po ke Weblate sebagai komponen awal kemudian mengatur pengaya Penemuan komponen untuk menemukan yang lainnya secara otomatis.

Konfigurasi komponen

Nama komponen

Documentation

Mask berkas

docs/locales/*/LC_MESSAGES/index.po

Templat untuk terjemahan baru

docs/locales/index.pot

Format berkas

berkas PO gettext

Penanda terjemahan

rst-text
Konfigurasi penemuan komponen

Ekspresi reguler untuk mencocokkan berkas terjemahan dengan

docs/locales/(?P<language>[^/.]*)/LC_MESSAGES/(?P<component>[^/]*)\.po

Sesuaikan nama komponen

Documentation: {{ component|title }}

Definisikan berkas dasar untuk terjemahan baru

docs/locales/{{ component }}.pot

Petunjuk

Apakah Anda lebih suka Sphinx hanya menghasilkan satu berkas PO? Sejak Sphinx 3.3.0, Anda dapat melakukannya menggunakan:

gettext_compact = "docs"

Anda dapat menemukan beberapa proyek dokumentasi yang diterjemahkan menggunakan pendekatan ini: