Docs multi-langues rapides avec RTDSPhinx-Php de SitePoint-tutoriel php-php.cn

Maison

développement back-end

tutoriel php

Docs multi-langues rapides avec RTDSPhinx-Php de SitePoint

Christopher Nolan

Feb 17, 2025 am 08:51 AM

RTDSPHinx-Php de SitePoint: Un squelette Sphinx rationalisé pour la documentation PHP multicangue

Ce post présente RTDSPhinx-PHP, un squelette Sphinx compatible ReadTheDocs conçu pour créer et déployer une documentation PHP multi-langue. Il simplifie le processus avec des directives préconfigurées, des paramètres sensibles et des styles optimisés pour la documentation de l'API et de la prose.

Caractéristiques de clé:

Localisation simplifiée: RTDSPHINX-PHP fournit une configuration de localisation prêt à l'emploi pour le développement local et le déploiement de ReadTheDocs. Les fichiers linguistiques sont automatiquement générés, rationalisant le processus de traduction.
Scripts utilitaires utiles: Les scripts inclus automatisent des tâches comme le remplacement des valeurs d'espace réservé, la mise à jour des fichiers après les modifications et la création de HTML à partir des traductions. PHPDomain est préinstallé pour l'intégration de projet PHP sans couture.
Intégration améliorée des lectures de lecture: CSS personnalisée assure une intégration visuelle optimale avec le thème ReadTheDocs, améliorant l'apparition de liens de méthode API dans le tableau des matières.
Déplacement de lecture des lectures: Le squelette prend en charge les exigences de publication multi-langues de ReadTheDocs en traitant chaque version linguistique comme un projet distinct.

PRENDRE:

Prérequis: Assurez-vous que Python et PIP sont installés.
Clone Le référentiel: Clone Le référentiel RTDSPhinx-Php: git clone https://github.com/sitepoint/rtdsphinx-php docs
Créer un environnement virtuel (facultatif): Ceci est recommandé pour gérer les dépendances du projet.
Installez les dépendances: Installer les packages requis: pip install -r requirements.txt
Générer des fichiers linguistiques: Générer des fichiers pour une nouvelle langue (par exemple, "JP" pour le japonais): bin/update.sh jp
traduire: modifier les fichiers .po dans le répertoire locale/jp/LC_MESSAGES.
Build html: compiler le html pour vos traductions: bin/build.sh jp en (pour le japonais et l'anglais).
Déployer sur ReadTheDocs: Créer des projets de lecture séparés pour chaque langue, puis les lier en tant que traductions dans les paramètres du projet principal.

Fast Multi-language Docs with SitePoint's RTDSphinx-PHP

Caractéristiques avancées:

Localisation: Le dossier locale contient des fichiers .po générés automatiquement (pour la traduction) et .mo fichiers (lisible par machine). Les fichiers .po utilisent msgid (texte d'origine) et msgstr (texte traduit). GetText et Sphinx gèrent automatiquement l'extraction des chaînes.
scripts utilitaires:
- configure.sh: remplace les valeurs d'espace réservé (nom du projet, auteur, limace).
- update.sh: met à jour .pot fichiers et génère de nouveaux fichiers .po.
- build.sh: compile .po fichiers et construit html.
PHPDOMAIN et Syntaxe Fait de surbrillance: RTDSPHINX-PHP est optimisé pour les projets PHP, avec la syntaxe PHP par défaut et le PHPDomain préinstallé pour la documentation Clear API.

Fast Multi-language Docs with SitePoint's RTDSphinx-PHP

CSS personnalisé: Personnalisez l'apparence en modifiant _static/css/my_theme.css.
Déploiement de lecturethedocs: Chaque version linguistique nécessite un projet de lecture distinct, lié comme une traduction dans les paramètres du projet principal.

Fast Multi-language Docs with SitePoint's RTDSphinx-PHP

Conclusion:

RTDSPHINX-PHP simplifie la création et le déploiement de la documentation multi-langues pour les projets PHP. Sa nature open source encourage les contributions communautaires et aide à atteindre un public plus large. Les FAQ ci-dessous répondent aux questions courantes concernant la documentation multicangue avec Sphinx.

Questions fréquemment posées (FAQ):

(La section FAQ de l'entrée d'origine est conservée ici, car elle répond directement aux préoccupations communes et fournit des informations précieuses.)