Dokumen pelbagai bahasa yang cepat dengan SitePoint ' s rtdsphinx-php

rtdsphinx-php SitePoint: Skeleton sphinx yang diselaraskan untuk dokumentasi PHP pelbagai bahasa

Jawatan ini memperkenalkan RTDSPHINX-PHP, rangka sphinx yang serasi dengan bacaan yang direka untuk membuat dan menggunakan dokumentasi PHP pelbagai bahasa. Ia memudahkan proses dengan arahan pra-konfigurasi, lalai yang masuk akal, dan gaya yang dioptimumkan untuk kedua-dua API dan dokumentasi prosa.

Ciri -ciri Utama:

• Penyetempatan yang dipermudahkan: RTDSPHINX-PHP menyediakan persediaan penyetempatan siap sedia untuk kedua-dua pembangunan tempatan dan penyebaran readthedocs. Fail bahasa dihasilkan secara automatik, menyelaraskan proses terjemahan.
• Skrip utiliti yang berguna: termasuk skrip mengautomasikan tugas seperti menggantikan nilai letak, mengemas kini fail selepas perubahan, dan membina HTML dari terjemahan. PHPDOMAIN telah dipasang untuk integrasi projek PHP yang lancar.
• Integrasi Readthedocs yang dipertingkatkan: CSS adat memastikan integrasi visual yang optimum dengan tema ReadThedocs, meningkatkan penampilan pautan kaedah API dalam jadual kandungan.
• Penyebaran Readthedocs: Skeleton menyokong keperluan penerbitan pelbagai bahasa ReadThedocs dengan merawat setiap versi bahasa sebagai projek yang berasingan.

Bermula:

1. Prasyarat: Pastikan python dan pip dipasang.
2. klon repositori: klon repositori rtdsphinx-php: git clone https://github.com/sitepoint/rtdsphinx-php docs
3. Buat persekitaran maya (pilihan): Ini disyorkan untuk menguruskan kebergantungan projek.
4. Pasang Dependencies: Pasang Pakej yang Diperlukan: pip install -r requirements.txt
5. menghasilkan fail bahasa: menghasilkan fail untuk bahasa baru (mis., "JP" untuk bahasa Jepun): bin/update.sh jp
6. Translate: Edit fail dalam direktori .po. locale/jp/LC_MESSAGES
7. Bina html: menyusun HTML untuk terjemahan anda: (untuk bahasa Jepun dan Bahasa Inggeris). bin/build.sh jp en
8. Deploy ke ReadThedocs: Buat projek Readthedocs berasingan untuk setiap bahasa, kemudian hubungkan mereka sebagai terjemahan dalam tetapan projek utama.

Ciri -ciri lanjutan:

• lokalisasi:

  Folder mengandungi fail yang dihasilkan secara automatik fail (untuk terjemahan) dan locale fail (mesin boleh dibaca). Fail .po menggunakan .mo (teks asal) dan .po (teks diterjemahkan). GetText dan Sphinx mengendalikan pengekstrakan rentetan secara automatik. msgid

• skrip utiliti:

  • configure.sh: Menggantikan nilai letak (nama projek, pengarang, slug).
  • update.sh: kemas kini .pot fail dan menjana fail .po baru.
  • build.sh: compiles .po fail dan membina html.
• PHPDOMAIN DAN SYNTAX PHPDOMINE:

  RTDSPHINX-PHP dioptimumkan untuk projek PHP, dengan penonjolan sintaks PHP lalai dan PHPDOMAIN pra-dipasang untuk dokumentasi API yang jelas.

Custom CSS:

Sesuaikan penampilan dengan mengubah suai
• .

  _static/css/my_theme.css

  Penyebaran ReadThedocs:
Setiap versi bahasa memerlukan projek ReadThedocs yang berasingan, dikaitkan sebagai terjemahan dalam tetapan projek utama.
Kesimpulan:

RTDSPHINX-PHP memudahkan penciptaan dan penggunaan dokumentasi pelbagai bahasa untuk projek PHP. Sifat sumber terbuka menggalakkan sumbangan komuniti dan membantu mencapai khalayak yang lebih luas. Soalan Lazim di bawah menangani soalan umum mengenai dokumentasi pelbagai bahasa dengan Sphinx.

Soalan Lazim (Soalan Lazim):

(bahagian Soalan Lazim dari input asal dikekalkan di sini, kerana ia secara langsung menangani kebimbangan umum dan memberikan maklumat yang berharga.)

bagaimana saya boleh menguruskan terjemahan dalam sphinx?

... (kandungan FAQ asal) ... Apakah amalan terbaik untuk dokumentasi multiversion dalam bahasa yang berbeza dalam sphinx?

... (kandungan FAQ asal) ...

bagaimana saya boleh mengantarabangsaan sphinx?

... (kandungan FAQ asal) ...

bagaimana saya dapat menyelesaikan masalah yang berkaitan dengan dokumentasi sphinx?

... (kandungan FAQ asal) ...

bagaimana saya boleh menggunakan php rtdsphinx SitePoint untuk dokumen pelbagai bahasa yang cepat?

... (kandungan FAQ asal) ...

bagaimana saya boleh menambah sokongan untuk bahasa tambahan dalam sphinx?

... (kandungan FAQ asal) ...

bagaimana saya boleh mengemas kini fail terjemahan saya di sphinx?

... (kandungan FAQ asal) ...

bagaimana saya boleh membina dokumen terjemahan saya di sphinx?

... (kandungan FAQ asal) ...

bagaimana saya boleh menterjemahkan kandungan saya di sphinx?

... (kandungan FAQ asal) ...

bagaimana saya boleh mengkonfigurasi sphinx untuk pengantarabangsaan?

... (kandungan FAQ asal) ...

Atas ialah kandungan terperinci Dokumen pelbagai bahasa yang cepat dengan SitePoint ' s rtdsphinx-php. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!