#godot #docs #howto

Hugo Locurcio 02ee80a0c8 Document glow in 2D in Environment and post-processing há 1 ano atrás
.github 1825a772e6 Bump actions/checkout from 3 to 4 há 2 anos atrás
_extensions da3f1a1275 GDScript: Document `match` pattern guards há 2 anos atrás
_static 17b652d181 Merge pull request #7863 from dalexeev/use-relative-font-size-for-code há 1 ano atrás
_templates ca94970356 Less intrusive 4.0 update state info (#7100) há 2 anos atrás
_tools e269ed9f56 Merge pull request #7884 from m4gr3d/update_android_plugin_tutorial há 1 ano atrás
about 02ee80a0c8 Document glow in 2D in Environment and post-processing há 1 ano atrás
classes fa785505b3 Docs: Update link to Android Gradle Build há 1 ano atrás
community 83346a6a5a Update remaining QA links há 1 ano atrás
contributing 365a295c04 Merge pull request #8253 from skyace65/Windows-Defender há 1 ano atrás
getting_started c631f75708 Merge pull request #8227 from raulsntos/csharp-support-update há 1 ano atrás
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) há 2 anos atrás
tutorials 02ee80a0c8 Document glow in 2D in Environment and post-processing há 1 ano atrás
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) há 4 anos atrás
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) há 4 anos atrás
.gitignore 47bacc95fd Added configuring ide for rider (#7420) há 2 anos atrás
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors há 5 anos atrás
.readthedocs.yml d9e0d8386e Add tools definition for RTD há 2 anos atrás
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources há 3 anos atrás
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license há 6 anos atrás
Makefile 31204023b6 Makefile: use sphinx-build -M há 2 anos atrás
README.md 9d1dd80374 Build ePubs of the documentation for offline reading há 2 anos atrás
conf.py 82fac20c98 Update Godot version to 4.2 há 2 anos atrás
index.rst 9d1dd80374 Build ePubs of the documentation for offline reading há 2 anos atrás
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs há 2 anos atrás
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting há 2 anos atrás
robots.txt fd5f6f4909 Appease our great search engine overlords há 5 anos atrás

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

To browse the documentation offline, you can use the mirror of the documentation hosted on DevDocs. To enable offline browsing on DevDocs, you need to:

  • Click the three dots in the top-left corner, choose Preferences.
  • Enable the desired version of the Godot documentation by checking the box next to it in the sidebar.
  • Click the three dots in the top-left corner, choose Offline data.
  • Click the Install link next to the Godot documentation.

You can also 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.

For mobile devices or e-readers, you can also download an ePub copy for offline reading (updated every Monday). Extract the ZIP archive then open the GodotEngine.epub file in an e-book reader application.

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.