#godot #docs #howto

Santiago Valdez 7ee0687714 correct a little typo on scripting_laguanges (#5903) vor 3 Jahren
.github b07952f635 Update pull request template to be similar to godotengine/godot (#5909) vor 3 Jahren
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 vor 3 Jahren
_static 308bde3cc0 Improve side-aligned image positioning (#5876) vor 3 Jahren
_templates 6ae96e7b50 Implemented Algolia search (#4884) vor 4 Jahren
_tools cd6e06c8ec Update "locale codes" list. vor 3 Jahren
about c3aec5ee8a Release policy: Q2 is over, 3.5 should be released in July vor 3 Jahren
classes 61fd183807 classref: Sync with current master branch (c4f0062f1) vor 3 Jahren
community 13d05e57e8 Docs writing guidelines: Replace "direct" with "active" vor 3 Jahren
development 8063184876 Always point to latest Pyston release on Compiling for Linux/*BSD (#5867) vor 3 Jahren
getting_started 7ee0687714 correct a little typo on scripting_laguanges (#5903) vor 3 Jahren
img 65345e94ee Update vector2_angle_to_point.png vor 3 Jahren
tutorials 15173a0eec Update Command line tutorial to match 4.0.alpha11 `--help` output (#5918) vor 3 Jahren
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) vor 4 Jahren
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) vor 4 Jahren
.gitignore ad6846b80e ReadTheDocs redirect automation. vor 3 Jahren
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors vor 5 Jahren
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 vor 5 Jahren
AUTHORS.md c7144215ef Fix formatting on AUTHORS.md file vor 3 Jahren
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license vor 6 Jahren
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial vor 5 Jahren
README.md 4060179184 Remove trailing space characters (#5251) vor 4 Jahren
conf.py a0af6b9df1 Updated the Lincense to match the current year vor 3 Jahren
index.rst 5cbff38341 Add missing Navigation category vor 3 Jahren
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" vor 5 Jahren
requirements.txt 88e9253fd0 Bump sphinxext-opengraph from 0.6.2 to 0.6.3 vor 3 Jahren
robots.txt fd5f6f4909 Appease our great search engine overlords vor 5 Jahren

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.