#godot #docs #howto

smix8 c8f7e92e34 Update navigation mesh baking doc 1 anno fa
.github 1825a772e6 Bump actions/checkout from 3 to 4 2 anni fa
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 anno fa
_static 04020f1c08 Fix `/` keyboard shortcut to allow typing `/` within the search field 1 anno fa
_styleguides 88970e5daa Add German style guide 1 anno fa
_templates 0a01baec10 Fix epub-related failures (#8207) 1 anno fa
_tools 643001f9b1 Merge pull request #8450 from Cerno-b/reorganise-about-headers 1 anno fa
about b411b347d7 Update release policy after 4.2 release. 4.0 is now EOL. 1 anno fa
classes bf7d0c19c3 classref: Sync with current master branch (1ba920f) 1 anno fa
community 5966ffdca4 Merge pull request #8364 from JohnSmith757/patch-1 1 anno fa
contributing 5064ed9fd1 Add instructions for rebasing onto a branch 1 anno fa
getting_started d06f0a0e83 Merge pull request #8557 from Piralein/input-mapping 1 anno fa
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 anni fa
tutorials c8f7e92e34 Update navigation mesh baking doc 1 anno fa
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 anni fa
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 anni fa
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 anni fa
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 anni fa
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 anni fa
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 anni fa
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 anni fa
Makefile 31204023b6 Makefile: use sphinx-build -M 2 anni fa
README.md 9d1dd80374 Build ePubs of the documentation for offline reading 2 anni fa
conf.py 04020f1c08 Fix `/` keyboard shortcut to allow typing `/` within the search field 1 anno fa
index.rst bc2ff75da2 Reorganise "about" headers 1 anno fa
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 anni fa
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting 2 anni fa
robots.txt fd5f6f4909 Appease our great search engine overlords 5 anni fa

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.