ホーム エクスプローラ ヘルプ
サインイン
Godot
/
godot-docs
同期ミラー https://github.com/godotengine/godot-docs.git
2
0
フォーク 0
ファイル 課題 0 Wiki

#godot #docs #howto

ツリー: 9baaf4dc42
ブランチ タグ
godot-docs
ZIP TAR.GZ
Hugo Locurcio 9baaf4dc42 Document registering an autoload when an editor plugin is enabled 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 4d600e9235 Increase spacing between list items to improve readability (#5962) 3 年 前
_templates 21f92e43d6 Add a link to doc writing guidelines to the header (#5947) 3 年 前
_tools 2be4e9b938 Codespell I18N locale fixes 3 年 前
about 63bf9a6be9 Release policy: Mark 3.5 stable release (#6057) 3 年 前
classes 04f66dc5d0 Fix various typos 3 年 前
community 824b19f9c9 Fix grammar error in Pull request workflow (#6039) 3 年 前
development 76b6c83ff5 Add missing dependincies like Alsa and Pulseaudio to Alpine linux one-liner 2 年 前
getting_started 688caeda96 Typo. 3 年 前
img a74fba1608 Cheatsheet of ease() with known names 3 年 前
tutorials 9baaf4dc42 Document registering an autoload when an editor plugin is enabled 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.