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: b8dcd3f18f
Branches Tags
godot-docs
ZIP TAR.GZ
Max Hilbrunner b8dcd3f18f Merge pull request #6553 from smix8/navregion_doc_update_4.x vor 2 Jahren
.github b07952f635 Update pull request template to be similar to godotengine/godot (#5909) vor 3 Jahren
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 vor 3 Jahren
_static 1e985a4f13 Merge pull request #6523 from YuriSizov/rtd-versions-local vor 2 Jahren
_templates 8d38e7501d Add a custom local template for the RTD panel vor 2 Jahren
_tools 3f8fd6d127 Rename Tutorials to Manual, move migration guide to a higher level (#6509) vor 2 Jahren
about 3f8fd6d127 Rename Tutorials to Manual, move migration guide to a higher level (#6509) vor 2 Jahren
classes 16f90657da classref: Sync with current master branch (f7cf9fb14) vor 2 Jahren
community 548267c279 Improve the Bisecting regressions page vor 2 Jahren
development 7dafd84edf Merge pull request #6378 from Calinou/improve-bisecting-regressions vor 2 Jahren
getting_started eb7c9618aa Jumping and squashing monsters - Typos vor 2 Jahren
img 4096508fb6 Change the square logo for a wide one (#6397) vor 2 Jahren
tutorials b8dcd3f18f Merge pull request #6553 from smix8/navregion_doc_update_4.x 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 ad6846b80e ReadTheDocs redirect automation. vor 3 Jahren
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors vor 5 Jahren
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 vor 5 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 f3d1dff63b Minor English improvements for Makefile vor 3 Jahren
README.md 1fe3fa4898 add a link to building the manual in readme vor 3 Jahren
conf.py 98e96ced67 Make the navigation sidebar less crowded and noisy vor 2 Jahren
index.rst 3f8fd6d127 Rename Tutorials to Manual, move migration guide to a higher level (#6509) vor 2 Jahren
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" vor 5 Jahren
requirements.txt a4a1d90c80 Bump sphinx-notfound-page from 0.8 to 0.8.3 vor 3 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

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.