#godot #docs #howto

Vince Nguyen c8f45094b5 Removed outdated documentation 2 vuotta sitten
.github b07952f635 Update pull request template to be similar to godotengine/godot (#5909) 3 vuotta sitten
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 vuotta sitten
_static 3b4328fb52 Update <kbd> style overrides 2 vuotta sitten
_templates 6e4cb63908 Update URL from "Learn how to contribute!" 2 vuotta sitten
_tools 6c08ab05d2 Split general debugging and architecture diagram documentation 2 vuotta sitten
about b4a43f14b8 Update copyright statement from 2022 to 'present' 2 vuotta sitten
classes 33c61914b4 classref: Sync with current master branch (2ac2db8de) 2 vuotta sitten
community dbfe3b1d26 Reorganize documentation for contributors 2 vuotta sitten
contributing 554394c5cd Update Python version requirements on Compiling pages 2 vuotta sitten
getting_started d83c3d8143 Sync renamed method in C++ code snippet 2 vuotta sitten
img 4096508fb6 Change the square logo for a wide one (#6397) 2 vuotta sitten
tutorials c8f45094b5 Removed outdated documentation 2 vuotta sitten
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 vuotta sitten
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 vuotta sitten
.gitignore ad6846b80e ReadTheDocs redirect automation. 3 vuotta sitten
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 vuotta sitten
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 vuotta sitten
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 2 vuotta sitten
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 vuotta sitten
Makefile f3d1dff63b Minor English improvements for Makefile 2 vuotta sitten
README.md 0500f4df7c Update links in README to fix broken URLs (#6589) 2 vuotta sitten
conf.py 7fc697f10e Fix typo in last commit 2 vuotta sitten
index.rst dbfe3b1d26 Reorganize documentation for contributors 2 vuotta sitten
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 vuotta sitten
requirements.txt 64a60696bf Pin additional build requirements to avoid syntax highlighting issues 2 vuotta sitten
robots.txt fd5f6f4909 Appease our great search engine overlords 5 vuotta sitten

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.