Inicio Explorar Axuda
Iniciar sesión
Godot
/
godot-docs
réplica de https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Ficheiros Incidencias 0 Wiki

#godot #docs #howto

Árbore: c6fedd287e
Ramas Etiquetas
godot-docs
ZIP TAR.GZ
Hugo Locurcio c6fedd287e Clarify deadzone difference for `Input.get_vector()` in Controllers (#4651) %!s(int64=4) %!d(string=hai) anos
.github aab75310c7 Update PR template %!s(int64=4) %!d(string=hai) anos
_extensions cf655aa176 Revert "Fix Sphinx `add_lexer()` deprecation in the GDScript extension (#4594)" %!s(int64=4) %!d(string=hai) anos
_static cbeb9212cc Fix the "ref" badge appearing twice in search results %!s(int64=4) %!d(string=hai) anos
_templates d494d19dac Remove trailing whitespace and irregular whitespace %!s(int64=5) %!d(string=hai) anos
_tools 5e3a7c8fd1 Add a tool to move rst files and images %!s(int64=5) %!d(string=hai) anos
about 761592598f Remove mentions of IRC in favor of the new Contributors Chat platform (#4644) %!s(int64=4) %!d(string=hai) anos
classes d0eb1eb6bc Move remaining files out of step_by_step/ %!s(int64=4) %!d(string=hai) anos
community 761592598f Remove mentions of IRC in favor of the new Contributors Chat platform (#4644) %!s(int64=4) %!d(string=hai) anos
development 6d45a91d1e Fix incorrect code block tab syntax in Controllers documentation (#4643) %!s(int64=4) %!d(string=hai) anos
getting_started 1cdd6c9cc7 Replace instance diagram images for readability on all backgrounds (#4609) %!s(int64=4) %!d(string=hai) anos
img e1e08419f6 Add a page referencing the Control gallery image and demo %!s(int64=4) %!d(string=hai) anos
tutorials c6fedd287e Clarify deadzone difference for `Input.get_vector()` in Controllers (#4651) %!s(int64=4) %!d(string=hai) anos
.gitattributes 34f97a7544 GitHub linguist: Mark .rst files as detectable %!s(int64=5) %!d(string=hai) anos
.gitignore 1361ffb70c Add _tools folder for utility scripts %!s(int64=5) %!d(string=hai) anos
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors %!s(int64=5) %!d(string=hai) anos
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 %!s(int64=5) %!d(string=hai) anos
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors %!s(int64=5) %!d(string=hai) anos
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license %!s(int64=6) %!d(string=hai) anos
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial %!s(int64=5) %!d(string=hai) anos
README.md bdeb07691a Fix URL typo in the README (#4415) %!s(int64=4) %!d(string=hai) anos
conf.py f528a844d6 Add a more descriptive custom 404 error page (#4624) %!s(int64=4) %!d(string=hai) anos
index.rst 761592598f Remove mentions of IRC in favor of the new Contributors Chat platform (#4644) %!s(int64=4) %!d(string=hai) anos
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" %!s(int64=5) %!d(string=hai) anos
requirements.txt f528a844d6 Add a more descriptive custom 404 error page (#4624) %!s(int64=4) %!d(string=hai) anos
robots.txt fd5f6f4909 Appease our great search engine overlords %!s(int64=5) %!d(string=hai) anos

README.md

Godot Engine documentation

This repository contains the source files of Godot Engine's documentation, in reStructuredText markup language (reST).

They are meant to be parsed with the Sphinx documentation builder to build the HTML documentation on Godot's website.

Theming

The Godot documentation uses the default sphinx_rtd_theme with many customizations applied on top. It will automatically switch between the light and dark theme depending on your browser/OS' theming preference.

If you use Firefox and wish to use the dark theme regardless of your OS configuration, you can install the Dark Website Forcer add-on.

Contributing

All contributors are welcome to help on the Godot documentation.

To get started, head to the Contributing section of the online manual. There, you will find all the information you need to write and submit changes.

Here are some quick links to the areas you might be interested in:

  1. Contributing to the online manual
  2. Contributing to the class reference
  3. Content guidelines
  4. Writing guidelines
  5. Translating the documentation

License

At the exception of the classes/ folder, all the content of this repository is licensed under the Creative Commons Attribution 3.0 Unported license (CC BY 3.0) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community". See LICENSE.txt for details.

The files in the classes/ folder are derived from Godot's main source repository and are distributed under the MIT license, with the same authors as above.