#godot #docs #howto

Max Hilbrunner 37b4b1430a Merge pull request #5604 from Calinou/gdnative-cpp-example-remove-nativescript-1.0 3 years ago
.github 7b35584569 GitHub Actions: Don't build with warnings-as-errors for offline doc 3 years ago
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 years ago
_static c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 years ago
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 years ago
_tools ceb405067a Fix RTD redirects 3 years ago
about 19c34237cc Remove `3.x` VR tutorials, add landing page for future XR docs (#5479) 3 years ago
classes 19fca2678c classref: Sync with latest 4.0-alpha 3 years ago
community f51542880f Fix a typo in Best practices for engine contributors (#5613) 3 years ago
development 1399f7bac3 Fix and improve Pyston instructions in Compiling for Linux, *BSD 3 years ago
getting_started 2ef8d8df34 Doc edit suggestion in '05.the_main_game_scene.rst' to avoid confusion (#5623) 3 years ago
img 65345e94ee Update vector2_angle_to_point.png 3 years ago
tutorials 37b4b1430a Merge pull request #5604 from Calinou/gdnative-cpp-example-remove-nativescript-1.0 3 years ago
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 years ago
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 years ago
.gitignore ad6846b80e ReadTheDocs redirect automation. 3 years ago
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 years ago
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 years ago
AUTHORS.md c7144215ef Fix formatting on AUTHORS.md file 3 years ago
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 years ago
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 years ago
README.md 4060179184 Remove trailing space characters (#5251) 3 years ago
conf.py a0af6b9df1 Updated the Lincense to match the current year 3 years ago
index.rst 19c34237cc Remove `3.x` VR tutorials, add landing page for future XR docs (#5479) 3 years ago
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 years ago
requirements.txt 0123b98f1c requirements: Update to Sphinx 4.4.0, RTD theme 1.0.0, notfound 0.8 3 years ago
robots.txt fd5f6f4909 Appease our great search engine overlords 5 years ago

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.