#godot #docs #howto

Ethan Ruhl 75b51ec2f4 Organize built-in order in CanvasItem shaders (#5716) 3 gadi atpakaļ
.github 6fa4b975cc Bump actions/checkout from 2 to 3 3 gadi atpakaļ
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 gadi atpakaļ
_static c9d554b3c7 Fix toctree expand icon colors and margins in the theme 3 gadi atpakaļ
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 gadi atpakaļ
_tools ceb405067a Fix RTD redirects 3 gadi atpakaļ
about 22309d6791 Update mentions of cylinder shape support for Godot 3.4 (#5697) 3 gadi atpakaļ
classes c80ee83362 classref: Sync with latest 4.0-alpha 3 gadi atpakaļ
community 943b1bf4d7 Add link to Asset Library to submission guide (#5678) 3 gadi atpakaļ
development 4784e1329a Remove outdated note about Very Sleepy (#5710) 3 gadi atpakaļ
getting_started 07947cf63d Update theme overrides section for Godot 3.4 in Score and replay (#5699) 3 gadi atpakaļ
img 65345e94ee Update vector2_angle_to_point.png 3 gadi atpakaļ
tutorials 75b51ec2f4 Organize built-in order in CanvasItem shaders (#5716) 3 gadi atpakaļ
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 gadi atpakaļ
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 gadi atpakaļ
.gitignore ad6846b80e ReadTheDocs redirect automation. 3 gadi atpakaļ
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 gadi atpakaļ
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 gadi atpakaļ
AUTHORS.md c7144215ef Fix formatting on AUTHORS.md file 3 gadi atpakaļ
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 gadi atpakaļ
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 gadi atpakaļ
README.md 4060179184 Remove trailing space characters (#5251) 3 gadi atpakaļ
conf.py a0af6b9df1 Updated the Lincense to match the current year 3 gadi atpakaļ
index.rst 19c34237cc Remove `3.x` VR tutorials, add landing page for future XR docs (#5479) 3 gadi atpakaļ
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 gadi atpakaļ
requirements.txt abee14c092 Bump sphinx-tabs from 3.3.0 to 3.3.1 3 gadi atpakaļ
robots.txt fd5f6f4909 Appease our great search engine overlords 5 gadi atpakaļ

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.