#godot #docs #howto

smix8 0babdc92d1 Add doc for navigation maps, different actor types, and actor locomotion 3 yıl önce
.github b07952f635 Update pull request template to be similar to godotengine/godot (#5909) 3 yıl önce
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 yıl önce
_static 81a4cc2002 Fix the styling of the HTML shell reference (#6119) 3 yıl önce
_templates 21f92e43d6 Add a link to doc writing guidelines to the header (#5947) 3 yıl önce
_tools 5fce24792d Remove visual scripting from the documentation 3 yıl önce
about 8b330feb43 Update the `2d` stretch mode name to `canvas_items` 3 yıl önce
classes c273baa258 classref: Sync with current master branch (4ba934bf3) 3 yıl önce
community 3d619dc8a6 Improvements for “Building the manual with Sphinx” (#6171) 2 yıl önce
development 98bb548d4a Fix doctool command 3 yıl önce
getting_started 7d951887f8 Merge pull request #6163 from ScriptsEngineer/patch-1 2 yıl önce
img a74fba1608 Cheatsheet of ease() with known names 3 yıl önce
tutorials 0babdc92d1 Add doc for navigation maps, different actor types, and actor locomotion 2 yıl önce
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 yıl önce
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 yıl önce
.gitignore ad6846b80e ReadTheDocs redirect automation. 3 yıl önce
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 yıl önce
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 yıl önce
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 yıl önce
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 yıl önce
Makefile f3d1dff63b Minor English improvements for Makefile 3 yıl önce
README.md 1fe3fa4898 add a link to building the manual in readme 3 yıl önce
conf.py 5175fb8256 Use official CC BY 3.0 terminology and resources 3 yıl önce
index.rst 5cbff38341 Add missing Navigation category 3 yıl önce
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 yıl önce
requirements.txt a4a1d90c80 Bump sphinx-notfound-page from 0.8 to 0.8.3 3 yıl önce
robots.txt fd5f6f4909 Appease our great search engine overlords 5 yıl önce

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. Building the manual
  6. 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.