#godot #docs #howto

Max Hilbrunner 7dd8c7f9af Merge pull request #5813 from Calinou/controller-m1-support пре 3 година
.github 67feb37d5c Bump actions/upload-artifact from 2 to 3 пре 3 година
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 пре 3 година
_static c9d554b3c7 Fix toctree expand icon colors and margins in the theme пре 3 година
_templates 6ae96e7b50 Implemented Algolia search (#4884) пре 4 година
_tools ceb405067a Fix RTD redirects пре 3 година
about 2ed7e26fae Fix code literal syntax in FAQ пре 3 година
classes c80ee83362 classref: Sync with latest 4.0-alpha пре 3 година
community ac757d4521 update an external URL in tutorials.rst пре 3 година
development c1b7505ef8 Update Custom Modules Latest to include header and class name changes. (#5205) пре 3 година
getting_started 9c69e628ba Fix typo: "intantiated" -> "instantiated" (#5810) пре 3 година
img 65345e94ee Update vector2_angle_to_point.png пре 3 година
tutorials ec88857ba4 Remove outdated notice about lack of controller support on Apple M1 пре 3 година
.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 c7144215ef Fix formatting on AUTHORS.md file пре 3 година
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license пре 6 година
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial пре 5 година
README.md 4060179184 Remove trailing space characters (#5251) пре 4 година
conf.py a0af6b9df1 Updated the Lincense to match the current year пре 3 година
index.rst 19c34237cc Remove `3.x` VR tutorials, add landing page for future XR docs (#5479) пре 3 година
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" пре 5 година
requirements.txt 88e9253fd0 Bump sphinxext-opengraph from 0.6.2 to 0.6.3 пре 3 година
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. 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.