ホーム エクスプローラ ヘルプ
サインイン
godotengine
/
godot-docs
同期ミラー https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
ファイル

Official EU-hosted mirror of the Godot Engine GitHub documentation repository, provided as backup and for anyone who cannot access GitHub due to US trade restrictions. Please only use the issue tracker if you are restricted from using GitHub.

ツリー: df0e11cb27
ブランチ タグ
godot-docs
ZIP TAR.GZ
Max Hilbrunner df0e11cb27 Merge pull request #10865 from godotengine/master 1 週間 前
.github df0e11cb27 Merge pull request #10865 from godotengine/master 1 週間 前
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` 4 ヶ月 前
_static 049b42989e Revert "Fix video alignment after dependency update" 2 ヶ月 前
_styleguides 88970e5daa Add German style guide 1 年間 前
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. 3 ヶ月 前
_tools f70686cdbe CI: Integrate `pre-commit` for style checks 5 ヶ月 前
about f03720228a Fix typo in Release policy 1 ヶ月 前
classes 416fa65fb6 classref: Sync with current master branch (15ff450) 1 ヶ月 前
community a15f86bc03 Merge branch 'master' into patch-1 2 週間 前
contributing e44bbb69c4 Merge pull request #10762 from Calinou/mesh-automatic-instancing 3 週間 前
getting_started 7f82289aee Update the getting started 3d tutorial for godot 4.x 1 週間 前
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 8 ヶ月 前
tutorials 8c18714228 Merge pull request #10780 from Lexyth/patch-2 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 2 ヶ月 前
.lycheeignore bf27bf2c96 Fix URL check errors 1 ヶ月 前
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 8 ヶ月 前
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 5 ヶ月 前
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 年 前
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 8 ヶ月 前
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 年 前
Makefile 31204023b6 Makefile: use sphinx-build -M 2 年 前
README.md d4b2a69cf6 Fix broken link in README to Contributing section 5 ヶ月 前
conf.py 6fd5aa26e3 Fix version for Edit on GitHub, should link to master 1 ヶ月 前
index.rst 9109f763c3 Branch docs version for Godot 4.4 1 ヶ月 前
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 年 前
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 5 ヶ月 前
requirements.txt 7fd2c763f2 Bump sphinxext-opengraph from 0.9.1 to 0.10.0 2 週間 前
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 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

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.