Startseite Erkunden Hilfe
Anmelden
Godot
/
godot-docs
Mirror von https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Dateien Issues 0 Wiki

#godot #docs #howto

Struktur: ab23d444dd
Branches Tags
godot-docs
ZIP TAR.GZ
Max Hilbrunner ab23d444dd Merge pull request #7457 from Calinou/multiple-resolutions-fix-stretch-mode-name vor 2 Jahren
.github 3a9355cd94 Fix the 4.0 branch CI vor 2 Jahren
_extensions 7d5fb4e6a2 Various fixups vor 2 Jahren
_static a11e0d78c0 Merge pull request #7409 from Calinou/abbr-add-mobile-display vor 2 Jahren
_templates ca94970356 Less intrusive 4.0 update state info (#7100) vor 2 Jahren
_tools 3a9355cd94 Fix the 4.0 branch CI vor 2 Jahren
about bef2b30d29 Merge pull request #7446 from mhilbrunner/get-rid-of-weirdness vor 2 Jahren
classes c39e8f8635 classref: Sync with current 4.0 branch (cfedb0a) vor 2 Jahren
community d21e992878 Update submitting_to_assetlib.rst (#7339) vor 2 Jahren
contributing bef2b30d29 Merge pull request #7446 from mhilbrunner/get-rid-of-weirdness vor 2 Jahren
getting_started bef2b30d29 Merge pull request #7446 from mhilbrunner/get-rid-of-weirdness vor 2 Jahren
img 3dfbfbf381 Add links to demo projects where relevant (#6874) vor 2 Jahren
tutorials ab23d444dd Merge pull request #7457 from Calinou/multiple-resolutions-fix-stretch-mode-name vor 2 Jahren
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) vor 4 Jahren
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) vor 4 Jahren
.gitignore bc925e0c80 Made a sentence easier to read and included a reference to class_String (#7034) vor 2 Jahren
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors vor 5 Jahren
.readthedocs.yml d9e0d8386e Add tools definition for RTD vor 2 Jahren
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources vor 3 Jahren
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license vor 6 Jahren
Makefile 31204023b6 Makefile: use sphinx-build -M vor 2 Jahren
README.md 9d1dd80374 Build ePubs of the documentation for offline reading vor 2 Jahren
conf.py 20e2417231 Merge branch 'master' into 4.0 vor 2 Jahren
index.rst ccb2aa4bc0 Merge branch 'master' into 4.0 vor 2 Jahren
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs vor 2 Jahren
requirements.txt 9956a1cff0 Merge pull request #7436 from bitsawer/update_pygments vor 2 Jahren
robots.txt fd5f6f4909 Appease our great search engine overlords vor 5 Jahren

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.