Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
Godot
/
godot-docs
zrkadlo https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Súbory Issues 0 Wiki

#godot #docs #howto

Strom: d0ae2e2be5
Branche Tagy
godot-docs
ZIP TAR.GZ
hpnrep6 d0ae2e2be5 Add missing C# example semicolon in Using AnimationTree (#5029) 4 rokov pred
.github 7444f4a8b3 GitHub Actions: Don't build offline docs on pushes and pull requests 4 rokov pred
_extensions 0a087e730f Update copyrights to 2021 4 rokov pred
_static 174765b147 Fix JavaScript class reference dark mode (#5004) 4 rokov pred
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 rokov pred
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 rokov pred
about e10fa30af6 Merge pull request #4824 from Calinou/faq-ui-toolkit 4 rokov pred
classes 20bcd1307a [Complex Text Layouts] Update tutorials and documentation to match TextServer changes. 4 rokov pred
community e38d9ffcaf Community channels: fix User groups link (#4991) 4 rokov pred
development de00d389ac Clarify the purpose of `load_steps` in TSCN file format (#5001) 4 rokov pred
getting_started b9b8b32435 Use explicit casting for `MobScene.Instance()` in 3D game tutorial (#5021) 4 rokov pred
img 4ed76436c8 Add an image for Camera3D is_position_behind and is_position_in_frustum (#4883) 4 rokov pred
tutorials d0ae2e2be5 Add missing C# example semicolon in Using AnimationTree (#5029) 4 rokov pred
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitignore 1361ffb70c Add _tools folder for utility scripts 5 rokov pred
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 rokov pred
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 rokov pred
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 rokov pred
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 rokov pred
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 rokov pred
README.md 4664df9819 Build offline documentation for the stable branch as well (#4896) 4 rokov pred
conf.py 6ae96e7b50 Implemented Algolia search (#4884) 4 rokov pred
index.rst 4664df9819 Build offline documentation for the stable branch as well (#4896) 4 rokov pred
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 rokov pred
requirements.txt 6ae96e7b50 Implemented Algolia search (#4884) 4 rokov pred
robots.txt fd5f6f4909 Appease our great search engine overlords 5 rokov pred

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

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.

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