#godot #docs #howto

Hugo Locurcio df8eecd177 Add FAQ items about portable mode and editor desktop integration 3 vuotta sitten
.github 67feb37d5c Bump actions/upload-artifact from 2 to 3 3 vuotta sitten
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 vuotta sitten
_static c9d554b3c7 Fix toctree expand icon colors and margins in the theme 3 vuotta sitten
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 vuotta sitten
_tools ceb405067a Fix RTD redirects 3 vuotta sitten
about df8eecd177 Add FAQ items about portable mode and editor desktop integration 3 vuotta sitten
classes c80ee83362 classref: Sync with latest 4.0-alpha 3 vuotta sitten
community ac757d4521 update an external URL in tutorials.rst 3 vuotta sitten
development c1b7505ef8 Update Custom Modules Latest to include header and class name changes. (#5205) 3 vuotta sitten
getting_started ce23617b1d 4.0 1st 2d game export,instance, and rand_range fixes (#5553) 3 vuotta sitten
img 65345e94ee Update vector2_angle_to_point.png 3 vuotta sitten
tutorials 1c71b31210 Document zero padding and left alignment in format string (#5790) 3 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 c7144215ef Fix formatting on AUTHORS.md file 3 vuotta sitten
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 vuotta sitten
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 vuotta sitten
README.md 4060179184 Remove trailing space characters (#5251) 4 vuotta sitten
conf.py a0af6b9df1 Updated the Lincense to match the current year 3 vuotta sitten
index.rst 19c34237cc Remove `3.x` VR tutorials, add landing page for future XR docs (#5479) 3 vuotta sitten
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 vuotta sitten
requirements.txt 88e9253fd0 Bump sphinxext-opengraph from 0.6.2 to 0.6.3 3 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. 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.