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

#godot #docs #howto

ツリー: 5de74ca72d
ブランチ タグ
godot-docs
ZIP TAR.GZ
Godot Organization 5de74ca72d classref: Sync with current master branch (2210111) 2 年 前
.github 59345d8ac6 Docs CI: Limit concurrent builds 2 年 前
_extensions 7d5fb4e6a2 Various fixups 2 年 前
_static 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 年 前
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 2 年 前
_tools 1b0310aa47 Fix typos and make CI a happy Gobot 2 年 前
about 34350f8a12 Document StandardMaterial3D refraction limitations (#7301) 2 年 前
classes 5de74ca72d classref: Sync with current master branch (2210111) 2 年 前
community d21e992878 Update submitting_to_assetlib.rst (#7339) 2 年 前
contributing bcb688ac87 Merge pull request #7408 from Calinou/internal-rendering-architecture-fix-abbr-usage 2 年 前
getting_started 9c2a7bafd0 Update instancing.rst 2 年 前
img 3dfbfbf381 Add links to demo projects where relevant (#6874) 2 年 前
tutorials b7b25baf26 Merge pull request #7422 from smix8/remove_agent_avoidance_4.x 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 bc925e0c80 Made a sentence easier to read and included a reference to class_String (#7034) 2 年 前
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 年 前
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 年 前
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 2 年 前
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 年 前
Makefile 31204023b6 Makefile: use sphinx-build -M 2 年 前
README.md 9d1dd80374 Build ePubs of the documentation for offline reading 2 年 前
conf.py 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 年 前
index.rst 9d1dd80374 Build ePubs of the documentation for offline reading 2 年 前
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 年 前
requirements.txt 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 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 use the mirror of the documentation hosted on DevDocs. To enable offline browsing on DevDocs, you need to:

  • Click the three dots in the top-left corner, choose Preferences.
  • Enable the desired version of the Godot documentation by checking the box next to it in the sidebar.
  • Click the three dots in the top-left corner, choose Offline data.
  • Click the Install link next to the Godot documentation.

You can also 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.

For mobile devices or e-readers, you can also download an ePub copy for offline reading (updated every Monday). 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

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.