#godot #docs #howto

Hana - Piralein 15fbfc5d64 Adding "Using System;" line to default C# script 1 год назад
.github dbb13eb5a9 Clarify where to report engine bugs 1 год назад
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 год назад
_static ab67eb8437 Merge pull request #9324 from rburing/css_self_links 1 год назад
_styleguides 88970e5daa Add German style guide 1 год назад
_templates bedd304160 Remove Giscus from search page (#8777) 1 год назад
_tools e92616b7af Merge pull request #9336 from smix8/nav_obstacles 1 год назад
about e7fdb120c7 Fix dead links in the documentation 1 год назад
classes 6e46dc002c classref: Sync with current master branch (b97110c) 1 год назад
community e7fdb120c7 Fix dead links in the documentation 1 год назад
contributing d2ccdb5154 Remove references to the no longer needed DXC 1 год назад
getting_started 15fbfc5d64 Adding "Using System;" line to default C# script 1 год назад
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 лет назад
tutorials 42e8bda57c Clarify `INV_VIEW_MATRIX` and `MAIN_CAM_INV_VIEW_MATRIX` (#9544) 1 год назад
.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 47bacc95fd Added configuring ide for rider (#7420) 2 лет назад
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 лет назад
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 лет назад
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 лет назад
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 лет назад
Makefile 31204023b6 Makefile: use sphinx-build -M 2 лет назад
README.md dbe3a88377 Fix various minor typos 1 год назад
conf.py 3e3bbde35b Add support for embedding videos in documentation pages 1 год назад
index.rst c5c215a179 Added separate links to stable/latest/3.6 copies of the offline documentation 1 год назад
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 лет назад
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages 1 год назад
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

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.