#godot #docs #howto

Mara Huldra 59c4480051 Update style guide for new signal emit/connect syntax 2 rokov pred
.github b07952f635 Update pull request template to be similar to godotengine/godot (#5909) 3 rokov pred
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 rokov pred
_static 3b4328fb52 Update <kbd> style overrides 2 rokov pred
_templates 6e4cb63908 Update URL from "Learn how to contribute!" 2 rokov pred
_tools 6c08ab05d2 Split general debugging and architecture diagram documentation 2 rokov pred
about 380f6cd673 Update ways to contribute and propose ideas in the FAQ 2 rokov pred
classes fc314262d1 classref: Sync with current master branch (929333fe2) 2 rokov pred
community a2c072e3e0 Fix broken link to Godot Recipes text tutorial (#6685) 2 rokov pred
contributing 1631de89e7 Add `--print-filenames` option to GDScript unit testing (#6706) 2 rokov pred
getting_started a4801672f2 fix(01.game_setup.rst): Extents->Size adjustments and new screenshots (#6547) 2 rokov pred
img 4096508fb6 Change the square logo for a wide one (#6397) 2 rokov pred
tutorials 59c4480051 Update style guide for new signal emit/connect syntax 2 rokov pred
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitignore ad6846b80e ReadTheDocs redirect automation. 3 rokov pred
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 rokov pred
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 rokov pred
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 rokov pred
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 rokov pred
Makefile f3d1dff63b Minor English improvements for Makefile 3 rokov pred
README.md 0500f4df7c Update links in README to fix broken URLs (#6589) 2 rokov pred
conf.py 7fc697f10e Fix typo in last commit 2 rokov pred
index.rst dbfe3b1d26 Reorganize documentation for contributors 2 rokov pred
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 rokov pred
requirements.txt 64a60696bf Pin additional build requirements to avoid syntax highlighting issues 2 rokov pred
robots.txt fd5f6f4909 Appease our great search engine overlords 5 rokov pred

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.