#godot #docs #howto

hughowens e5f3f1f928 Update references to "Mono" menu item to "Dotnet" пре 2 година
.github 9473b6c9e3 Enable error reporting on the CI and address the remaining errors пре 2 година
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 пре 3 година
_static 1da407b921 Move the latest branch warning into templates пре 2 година
_templates 1da407b921 Move the latest branch warning into templates пре 2 година
_tools 6c08ab05d2 Split general debugging and architecture diagram documentation пре 2 година
about f951304fbe Fix heading type in the list of features (regression from #6796 and #6773) пре 2 година
classes 1dc22280b6 classref: Sync with current master branch (e0de3573f) пре 2 година
community 87298c021f Update FAQ for Godot 4.0 пре 2 година
contributing 8f585bfd84 Fix Python link typo in Compiling for Linux (#6794) пре 2 година
getting_started 4da9f813fc Fix your first 3D game issues (#6763) пре 2 година
img 4096508fb6 Change the square logo for a wide one (#6397) пре 2 година
tutorials e5f3f1f928 Update references to "Mono" menu item to "Dotnet" пре 2 година
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) пре 4 година
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) пре 4 година
.gitignore ad6846b80e ReadTheDocs redirect automation. пре 3 година
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors пре 5 година
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 пре 5 година
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources пре 2 година
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license пре 6 година
Makefile e7c7cf1510 Allow specifying a list of files for the make command пре 2 година
README.md 0500f4df7c Update links in README to fix broken URLs (#6589) пре 2 година
conf.py 1da407b921 Move the latest branch warning into templates пре 2 година
index.rst dbfe3b1d26 Reorganize documentation for contributors пре 2 година
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" пре 5 година
requirements.txt 64a60696bf Pin additional build requirements to avoid syntax highlighting issues пре 2 година
robots.txt fd5f6f4909 Appease our great search engine overlords пре 5 година

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.