#godot #docs #howto

Max Hilbrunner ad40eb1a2e Merge pull request #9309 from skyace65/ScriptTemplate há 1 ano atrás
.github b08b23d19b Build offline version of stable branch há 1 ano atrás
_extensions 0a01baec10 Fix epub-related failures (#8207) há 1 ano atrás
_static ac92bfb47a Merge pull request #9015 from adamscott/fix-website-highlight há 1 ano atrás
_styleguides 88970e5daa Add German style guide há 1 ano atrás
_templates bedd304160 Remove Giscus from search page (#8777) há 1 ano atrás
_tools dbe3a88377 Fix various minor typos há 1 ano atrás
about 644552ddd2 Release policy: Bump 4.3 ETA to June há 1 ano atrás
classes b41817daaf classref: Sync with current master branch (6118592) há 1 ano atrás
community 8520601b13 Update the community channels há 1 ano atrás
contributing 4aec1e094c Fix grammar mistake in scripting_development há 1 ano atrás
getting_started 9ec1210d33 Fix button description há 1 ano atrás
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) há 2 anos atrás
tutorials f941feee55 Add info on script template folders 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 dbe3a88377 Fix various minor typos há 1 ano atrás
conf.py 3e3bbde35b Add support for embedding videos in documentation pages há 1 ano atrás
index.rst c5c215a179 Added separate links to stable/latest/3.6 copies of the offline documentation há 1 ano atrás
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs há 2 anos atrás
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages há 1 ano 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 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

With 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.