Начало Каталог Помощ
Вход
Godot
/
godot-docs
огледало от https://github.com/godotengine/godot-docs.git
2
0
Разклонения 0
Файлове Задачи 0 Уики

#godot #docs #howto

ИН на ревизия: 00beb9f6f5
Клонове Маркери
godot-docs
ZIP TAR.GZ
Rémi Verschelde 00beb9f6f5 Data paths: Fix editor paths and improve docs on custom user dir преди 2 години
.github b07952f635 Update pull request template to be similar to godotengine/godot (#5909) преди 3 години
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 преди 3 години
_static 81a4cc2002 Fix the styling of the HTML shell reference (#6119) преди 2 години
_templates 21f92e43d6 Add a link to doc writing guidelines to the header (#5947) преди 3 години
_tools 5fce24792d Remove visual scripting from the documentation преди 2 години
about d917648102 Remove mentions of VisualScript in the documentation преди 2 години
classes 465dd176b6 classref: Sync with current master branch (46a568e0a) преди 2 години
community d917648102 Remove mentions of VisualScript in the documentation преди 2 години
development 8bb2b02eda Update compiling_for_android.rst (#6115) преди 2 години
getting_started 0ca949a46c Update GDScript syntax in the First 3D game tutorial (#6118) преди 2 години
img a74fba1608 Cheatsheet of ease() with known names преди 3 години
tutorials 00beb9f6f5 Data paths: Fix editor paths and improve docs on custom user dir преди 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 ad6846b80e ReadTheDocs redirect automation. преди 3 години
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors преди 5 години
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 преди 5 години
AUTHORS.md c7144215ef Fix formatting on AUTHORS.md file преди 3 години
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license преди 6 години
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial преди 5 години
README.md 1fe3fa4898 add a link to building the manual in readme преди 3 години
conf.py a0af6b9df1 Updated the Lincense to match the current year преди 3 години
index.rst 5cbff38341 Add missing Navigation category преди 3 години
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" преди 5 години
requirements.txt a4a1d90c80 Bump sphinx-notfound-page from 0.8 to 0.8.3 преди 3 години
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

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.