#godot #docs #howto

Rémi Verschelde ad3ca732d3 Android: Update screenshot showing Custom Build option 3 سال پیش
.github 67feb37d5c Bump actions/upload-artifact from 2 to 3 3 سال پیش
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 سال پیش
_static 308bde3cc0 Improve side-aligned image positioning (#5876) 3 سال پیش
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 سال پیش
_tools cd6e06c8ec Update "locale codes" list. 3 سال پیش
about c3aec5ee8a Release policy: Q2 is over, 3.5 should be released in July 3 سال پیش
classes 61fd183807 classref: Sync with current master branch (c4f0062f1) 3 سال پیش
community 13d05e57e8 Docs writing guidelines: Replace "direct" with "active" 3 سال پیش
development 8063184876 Always point to latest Pyston release on Compiling for Linux/*BSD (#5867) 3 سال پیش
getting_started 9c69e628ba Fix typo: "intantiated" -> "instantiated" (#5810) 3 سال پیش
img 65345e94ee Update vector2_angle_to_point.png 3 سال پیش
tutorials ad3ca732d3 Android: Update screenshot showing Custom Build option 3 سال پیش
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 سال پیش
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 سال پیش
.gitignore ad6846b80e ReadTheDocs redirect automation. 3 سال پیش
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 سال پیش
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 سال پیش
AUTHORS.md c7144215ef Fix formatting on AUTHORS.md file 3 سال پیش
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 سال پیش
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 سال پیش
README.md 4060179184 Remove trailing space characters (#5251) 4 سال پیش
conf.py a0af6b9df1 Updated the Lincense to match the current year 3 سال پیش
index.rst 5cbff38341 Add missing Navigation category 3 سال پیش
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 سال پیش
requirements.txt 88e9253fd0 Bump sphinxext-opengraph from 0.6.2 to 0.6.3 3 سال پیش
robots.txt fd5f6f4909 Appease our great search engine overlords 5 سال پیش

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.