Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Contribuer à la documentation

Ce guide explique comment contribuer à la documentation de Godot, que ce soit en écrivant ou en révisant des pages.

Voir aussi

Si vous souhaitez traduire des pages ou la référence de la classe de l'anglais vers d'autres langues, lisez Editor and documentation localization.

Commencer

Pour modifier ou créer des pages dans le manuel de référence, vous devez modifier les fichiers .rst dans le dépôt GitHub godot-docs. La modification de ces pages dans une pull request déclenche une reconstruction de la documentation en ligne lors de la fusion.

Voir aussi

Pour plus de détails sur l'utilisation de Git et sur le flux de travail des Pull Requests, veuillez vous référer à la page Flux de travail pour les Pull Request. La plupart de ce qu'elle décrit concernant le dépôt principal godotengine/godot est également valable pour le dépôt docs.

Avertissement

The class reference's source files are in the Godot engine repository. We generate the Class Reference section of this documentation from them. If you want to update the description of a class, its methods, or properties, read Contribuer à la référence des classes.

Qu'est-ce la documentation de Godot

La documentation Godot est conçue comme un manuel de référence complet pour le moteur de jeu Godot. Elle n'est pas censée contenir des didacticiels pas à pas, à l'exception de deux didacticiels de création de jeux dans la section Démarrage.

Nous nous efforçons de rédiger des contenus factuels dans un langage accessible et bien écrit. Pour contribuer, vous devriez également lire :

  1. Writing guidelines. There, you will find rules and recommendations to write in a way that everyone understands.

  2. Directives relatives au contenu. They explain the principles we follow to write the documentation and the kind of content we accept.

Contribuer aux changements

Les Pull Requests doivent utiliser la branche master par défaut. Ne faites des demandes de Pull que sur d'autres branches (par exemple 2.1 ou 3.0) si vos modifications ne s'appliquent qu'à cette version spécifique de Godot.

Bien que moins pratique à modifier qu'un wiki, ce dépôt Git est l'endroit où nous écrivons la documentation. Avoir un accès direct aux fichiers sources dans un système de contrôle de révision est un plus pour assurer la qualité de notre documentation.

Modifier des pages existantes

To edit an existing page, locate its .rst source file and open it in your favorite text editor. You can then commit the changes, push them to your fork, and make a pull request. Note that the pages in classes/ should not be edited here. They are automatically generated from Godot's XML class reference. See Contribuer à la référence des classes for details.

Voir aussi

Pour compiler le manuel et tester les modifications sur votre ordinateur, consultez Compiler le manuel avec Sphinx.

Modifier des pages en ligne

Vous pouvez modifier la documentation en ligne en cliquant sur le lien Editer sur GitHub en haut à droite de chaque page.

Vous accédez ainsi à l'éditeur de texte de GitHub. Vous devez avoir un compte GitHub et vous connecter pour l'utiliser. Une fois connecté, vous pouvez proposer des modifications comme suit :

  1. Cliquez sur le bouton Edit on GitHub.

  2. Sur la page GitHub où vous êtes dirigé, cliquez sur l'icône crayon dans le coin supérieur droit près des boutons Raw, Blame et Delete. Il y a l'info-bulle "Fork this project and edit the file".

  3. Modifiez le texte dans l'éditeur de texte.

  4. Au bas de la page Web, résumez les modifications que vous avez apportées et cliquez sur le bouton Propose file change. Veillez à remplacer le caractère générique "Update file.rst" par une description courte mais claire d'une ligne, car il s'agit du titre du commit.

  5. Sur les écrans suivants, cliquez sur le bouton Create pull request jusqu'à ce que vous voyiez un message comme Username wants to merge 1 commit into godotengine:master from Username:patch-1.

Un autre contributeur examinera vos modifications et les intégrera dans la documentation si elles sont bonnes. Il peut également apporter des modifications ou vous demander de le faire avant la fusion.

Ajouter de nouvelles pages

Avant d’ajouter une nouvelle page, assurez-vous qu’elle s’intègre dans la documentation :

  1. Recherchez les ` questions existantes <https://github.com/godotengine/godot-docs/issues>`_ ou ouvrez-en une nouvelle pour voir si la page est nécessaire.

  2. Assurez-vous qu'il n'y a pas une page qui couvre déjà le sujet.

  3. Lisez notre Directives relatives au contenu.

Pour ajouter une nouvelle page, créez un fichier .rst avec un nom significatif dans la section à laquelle vous voulez ajouter un fichier, par exemple tutorials/3d/light_baking.rst.

Vous devez ensuite ajouter votre page au "toctree" (table des matières, par exemple tutorials/3d/index.rst). Ajoutez votre nouveau nom de fichier à la liste sur une nouvelle ligne, en utilisant un chemin relatif et sans extension, par exemple ici light_baking.

Titres

Commencez toujours les pages par leur titre et un nom de référence Sphinx :

.. _doc_insert_your_title_here:

Insert your title here
======================

La référence _doc_insert_your_title_here et le titre doivent correspondre.

La référence permet un lien vers cette page en utilisant le format :ref:, par exemple :ref:`doc_insérer_votre_titre_ici` aurait un lien pour l'exemple ci-dessus page (notez l'absence de préfixe tiret du bas '_' dans la référence).

Rédigez vos titres comme des phrases simples, sans mettre de majuscules à chaque mot :

  • Bien : Comprendre les signaux dans Godot

  • Bien : Comprendre Les Signaux Dans Godot

Seuls les noms propres, les projets, les personnes et les noms de classes de nœuds doivent avoir leur première lettre en majuscule.

Syntaxe Sphinx et reStructuredText

Check Sphinx's reST Primer and the official reference for details on the syntax.

Sphinx utilise des commentaires reST spécifiques pour effectuer des opérations spécifiques, comme la définition de la table des matières (.. toctree::) ou les références croisées de pages. Consultez la documentation officielle de Sphinx pour plus de détails. Pour apprendre à utiliser les directives Sphinx comme .. note:: ou .. seealso::, consultez la documentation des directives Sphinx.

Ajout d'images et de pièces jointes

Pour ajouter des images, veuillez les placer dans un dossier img/ à côté du fichier .rst avec un nom significatif et les inclure dans votre page avec :

.. image:: img/image_name.webp

Alternatively, you can use the figure directive, which gives the image a contrasting border and allows centering it on the page.

.. figure:: img/image_name.webp
    :align: center

You can also include attachments as support material for a tutorial, by placing them into a files/ folder next to the .rst file, and using this inline markup:

:download:`file_name.zip <files/file_name.zip>`

Consider using the godot-docs-project-starters <https://github.com/godotengine/godot-docs-project-starters> repository for hosting support materials, such as project templates and asset packs. You can use a direct link to the generated archive from that repository with the regular link markup:

`file_name.zip <https://github.com/godotengine/godot-docs-project-starters/releases/download/latest-4.x/file_name.zip>`_

Licence

This documentation and every page it contains is published under the terms of the Creative Commons Attribution 3.0 license (CC BY 3.0), with attribution to "Juan Linietsky, Ariel Manzur and the Godot community".

En contribuant à la documentation sur le dépôt GitHub, vous acceptez que vos modifications soient distribuées sous cette licence.