2
0

#godot #docs #howto

Godot Organization 9afaf48fc7 classref: Sync with current master branch (cb7cd81) 2 долоо хоног өмнө
.github f875de93e5 Update contributing links to contributing.godotengine.org. 1 сар өмнө
_extensions 3a50eec76b read classes from file when lexing 1 сар өмнө
_static 2d9c2365d4 Fix redirects in safari, by moving the redirect js script into the 404 page instead of checking if we're on 404 via the API. 3 долоо хоног өмнө
_styleguides 0855668721 Migrate contributing contents to a separate documentation site. 1 сар өмнө
_templates 0855668721 Migrate contributing contents to a separate documentation site. 1 сар өмнө
_tools e69b689540 Add JavaScript-based redirects to supplement Read the Docs redirects 3 долоо хоног өмнө
about 91e6e63588 Update release policy with info now that 4.5 is released 2 долоо хоног өмнө
classes 9afaf48fc7 classref: Sync with current master branch (cb7cd81) 2 долоо хоног өмнө
community a15f86bc03 Merge branch 'master' into patch-1 6 сар өмнө
engine_details ef817d5ddf Update object_class.rst , updating connect()'s code sample and relevant explanation (#11341) 2 долоо хоног өмнө
getting_started cab0c1cb9e Link to GDExtension articles from the Godot introduction. 1 сар өмнө
img a82ed18d3d Add FoldableContainer to the Control node gallery page 3 сар өмнө
tutorials 5e6880717d Add Rectangle Example to ArrayMesh (#11247) 2 долоо хоног өмнө
.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 965685e247 Add more Python-related files to gitignore 9 сар өмнө
.lycheeignore bf27bf2c96 Fix URL check errors 7 сар өмнө
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 жил өмнө
.pre-commit-config.yaml 0855668721 Migrate contributing contents to a separate documentation site. 1 сар өмнө
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 жил өмнө
404.rst 1ffd71c5e7 Fix RTD language switcher redirecting to nonexistent `/en/4.x/` branch 2 долоо хоног өмнө
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 жил өмнө
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 жил өмнө
Makefile 31204023b6 Makefile: use sphinx-build -M 2 жил өмнө
README.md f875de93e5 Update contributing links to contributing.godotengine.org. 1 сар өмнө
conf.py 3cc1b0d979 Bump version 1 сар өмнө
index.rst 0855668721 Migrate contributing contents to a separate documentation site. 1 сар өмнө
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 жил өмнө
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 11 сар өмнө
requirements.txt 01970e58b2 Bump sphinxext-opengraph from 0.12.0 to 0.13.0 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 (updated every Monday): stable, latest, 3.6. 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 (updated every Monday): stable, latest, 3.6. 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 documentation. 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.