首頁 探索 說明
登入
Godot
/
godot-docs
镜像来自 https://github.com/godotengine/godot-docs.git
2
0
複刻 0
檔案 問題管理 0 Wiki

#godot #docs #howto

分支: classref/sync-cb7cd81
分支列表 標籤列表
godot-docs
ZIP TAR.GZ
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.