Начало Каталог Помощ
Вход
Godot
/
godot-docs
огледало от https://github.com/godotengine/godot-docs.git
2
0
Разклонения 0
Файлове Задачи 0 Уики

#godot #docs #howto

ИН на ревизия: 147e996bbd
Клонове Маркери
godot-docs
ZIP TAR.GZ
Matthew 147e996bbd Merge pull request #7641 from kastromatos/patch-1 преди 2 години
.github 45c425079f Tell codespell to ignore the locale code page (#7519) преди 2 години
_extensions 7d5fb4e6a2 Various fixups преди 2 години
_static b57807b618 Make it possible to read abbreviations by tapping on mobile преди 2 години
_templates ca94970356 Less intrusive 4.0 update state info (#7100) преди 2 години
_tools 45c425079f Tell codespell to ignore the locale code page (#7519) преди 2 години
about db196f3f33 Update documentation changelog for 4.1 преди 2 години
classes 029de7825e classref: Sync with current master branch (c83f912) преди 2 години
community e0227200c4 Update community/tutorials.rst преди 2 години
contributing e79fc215ab macOS: Move Vulkan SDK from a note to a requirement преди 2 години
getting_started b9b79fe4c7 Update screenshots in Introduction section преди 2 години
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) преди 2 години
tutorials 147e996bbd Merge pull request #7641 from kastromatos/patch-1 преди 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 47bacc95fd Added configuring ide for rider (#7420) преди 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 преди 3 години
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 82fac20c98 Update Godot version to 4.2 преди 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 b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting преди 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.