#godot #docs #howto

Matthew 336c6747af Change link on the first script page (#5677) hace 3 años
.github 6fa4b975cc Bump actions/checkout from 2 to 3 hace 3 años
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 hace 3 años
_static c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 hace 3 años
_templates 6ae96e7b50 Implemented Algolia search (#4884) hace 4 años
_tools ceb405067a Fix RTD redirects hace 3 años
about 141b524cd5 Change estimated release date for Godot 3.5 to Q2 2022 hace 3 años
classes c80ee83362 classref: Sync with latest 4.0-alpha hace 3 años
community e82b433b6d Recommend avoiding the List datatype in C++ usage guidelines hace 3 años
development 1399f7bac3 Fix and improve Pyston instructions in Compiling for Linux, *BSD hace 3 años
getting_started 336c6747af Change link on the first script page (#5677) hace 3 años
img 65345e94ee Update vector2_angle_to_point.png hace 3 años
tutorials 1381983226 fix 'making_plugin' tutorial code snippet (#5585) hace 3 años
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) hace 4 años
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) hace 4 años
.gitignore ad6846b80e ReadTheDocs redirect automation. hace 3 años
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors hace 5 años
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 hace 5 años
AUTHORS.md c7144215ef Fix formatting on AUTHORS.md file hace 3 años
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license hace 6 años
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial hace 5 años
README.md 4060179184 Remove trailing space characters (#5251) hace 4 años
conf.py a0af6b9df1 Updated the Lincense to match the current year hace 3 años
index.rst 19c34237cc Remove `3.x` VR tutorials, add landing page for future XR docs (#5479) hace 3 años
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" hace 5 años
requirements.txt 664f6a1cbd Bump sphinx-tabs from 3.2.0 to 3.3.0 (#5672) hace 3 años
robots.txt fd5f6f4909 Appease our great search engine overlords hace 5 años

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.

Download for offline use

You can download an HTML copy for offline reading (updated every Monday). Extract the ZIP archive then open the top-level index.html in a web browser.

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.