Startsida Utforska Hjälp
Logga in
Godot
/
godot-docs
spegling av https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Filer Ärenden 0 Wiki

#godot #docs #howto

Träd: b81f0030b7
Grenar Taggar
godot-docs
ZIP TAR.GZ
Henry Catalini Smith b81f0030b7 Add macOS keyboard shortcut in Creating your first script (#6032) 3 år sedan
.github b07952f635 Update pull request template to be similar to godotengine/godot (#5909) 3 år sedan
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 år sedan
_static 4d600e9235 Increase spacing between list items to improve readability (#5962) 3 år sedan
_templates 21f92e43d6 Add a link to doc writing guidelines to the header (#5947) 3 år sedan
_tools cd6e06c8ec Update "locale codes" list. 3 år sedan
about 04f66dc5d0 Fix various typos 3 år sedan
classes 04f66dc5d0 Fix various typos 3 år sedan
community b82de55573 Rename OSX to macOS and iPhoneOS to iOS. Update iOS build instructions. 3 år sedan
development 41a52aff87 Describe actual purpose of the index keyword in TSCN file format (#6021) 3 år sedan
getting_started b81f0030b7 Add macOS keyboard shortcut in Creating your first script (#6032) 3 år sedan
img 65345e94ee Update vector2_angle_to_point.png 3 år sedan
tutorials 4a1cd6c9b6 Clarify `hint_range` in Shading language (#6029) 3 år sedan
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 år sedan
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 år sedan
.gitignore ad6846b80e ReadTheDocs redirect automation. 3 år sedan
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 år sedan
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 år sedan
AUTHORS.md c7144215ef Fix formatting on AUTHORS.md file 3 år sedan
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 år sedan
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 år sedan
README.md 1fe3fa4898 add a link to building the manual in readme 3 år sedan
conf.py a0af6b9df1 Updated the Lincense to match the current year 3 år sedan
index.rst 5cbff38341 Add missing Navigation category 3 år sedan
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 år sedan
requirements.txt a4a1d90c80 Bump sphinx-notfound-page from 0.8 to 0.8.3 3 år sedan
robots.txt fd5f6f4909 Appease our great search engine overlords 5 år sedan

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