文档指南

This page describes the rules to follow if you want to contribute to Godot Engine by writing or reviewing documentation, or by translating existing documentation. Also, have a look at README of the godot-docs GitHub repository and the docs front page on what steps to follow and how to contact the docs team.

如何贡献

创建或修改文档页面主要通过 godot-docs GitHub存储库 来完成。HTML(或PDF和EPUB)文档是从该存储库中的.rst文件(reStructuredText标记语言)生成的。在拉取请求中修改这些页面并将其合并将触发重建在线文档。

参见

有关Git用法和拉取请求工作流程的详细信息,请参阅 拉取请求(PR)工作流程 页面。它描述的关于主godotengine/godot存储库的大部分内容,这对文档存储库也是有效的。

README.md文件包含了开始所需的所有信息,请阅读它。特别是,它包含一些提示和技巧以及有关reStructuredText标记语言的参考文档的链接。

警告

如果您想编辑 API参考手册 ,请注意它 应该在godot-docs存储库中完成。而是,您应该编辑Godot的主存储库的 doc/classes/* XML文件。这些文件随后将用于生成编辑器内文档以及在线文档的API参考手册。在这里 Contributing to the class reference 阅读更多。

什么是良好的文档?

Documentation should be well written in plain English, using well-formed sentences and various levels of sections and subsections. It should be clear and objective. Also, have a look at the 文档编写指南.

我们通过以下定义将教程页面与其他文档页面区分开:

  • 教程:该页面旨在说明如何在编辑器或脚本中使用一个或多个概念,以达到具有学习目的的特定目标(例如“制作简单的2d Pong游戏”,“向对象施加力”)。
  • 文档:一个页面,如果可能的话,一次只描述一个且只有一个概念(例如Sprite类的方法列表,或者Godot中输入管理的概述)。

只要您遵守以下规则(以及储存库中的规则),你可以自由地编写你想的那种文档。

标题

始终以标题和Sphinx引用名称开始页面:

.. _doc_insert_your_title_here:

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

The reference allows linking to this page using the :ref: format, e.g. :ref:`doc_insert_your_title_here` would link to the above example page (note the lack of leading underscore in the reference).

另外,避免使用美国驼峰式标题:标题的第一个单词应以大写字母开头,而后面的每个单词都不应该大写。因此,这是一个很好的示例:

  • Insert your title here

这是一个糟糕的示例:

  • Insert Your Title Here

只有项目、人员和节点类名称应该首字母大写。

翻译现有页面

您可以帮助我们翻译或校对托管在 Hosted Weblate 上的官方Godot文档。

Translation state

There also is the official Godot i18n repository where you can see when the data was last synchronized.

许可证

本文档及其包含的每个页面均根据 知识共享署名3.0许可证(CC-BY-3.0) 的条款发布 ,归属于“Juan Linietsky,Ariel Manzur和Godot社区”。

通过贡献GitHub存储库上的文档,您同意您的更改是根据此许可证分发的。