Compiler la doc de PHP

Travaillant actuellement sur la traduction française de la documentation de PHP, j’ai besoin d’appliquer les patchs que je produis sur la documentation actuelle pour me rendre compte du résultat.

Je vous partage les quelques commandes à réaliser pour extraire et générer la documentation.

Pour compiler la documentation française de PHP il est nécessaire d’avoir PHP, SVN et GIT d’installé sur la machine.

La première chose à faire est d’extraire le dépôt via le terminal :

$ svn co https://svn.php.net/repository/phpdoc/modules/doc-fr

L’accès est en lecture seul sur le dépôt, mais cela n’empêche pas de récupérer les sources.

Maintenant, entrer dans le dossier doc-fr puis récupérer l’outil PHD. Il permet la génération de la documentation en XHTML.

doc-fr$ git clone git clone http://git.php.net/repository/phd.git

Il est possible de générer une première fois la documentation. Pour cela exécuter la commande configure suivante :

doc-fr$ php doc-base/configure.php --lang=fr

Enfin, pour générer les pages HTML, exécuter la commande suivante :

doc-fr$ php phd/render.php --docbook doc-base/.manual.xml --package PHP --format xhtml --lang fr

La génération de la documentation peut être lente, car il est nécessaire de tout indexer.

Afin de naviguer dans la documentation ainsi générée, il est possible d’utiliser le serveur intégré de PHP.

doc-fr$ cd output/php-chunked-xhtml && php -S 0.0.0.0:8000

Ouvrez votre navigateur et saisir l’URL suivante http://127.0.0.1:8000