#godot #docs #howto

Max Hilbrunner 2a41e90bd9 Merge pull request #8738 from jsjtxietian/patch-3 1 год назад
.github 1ec0392dff Merge pull request #8627 from godotengine/dependabot/github_actions/actions/upload-artifact-4 1 год назад
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 год назад
_static 87ab4cafa5 Fix `/` keyboard shortcut to allow typing `/` within the search field 1 год назад
_styleguides 88970e5daa Add German style guide 1 год назад
_templates 0a01baec10 Fix epub-related failures (#8207) 1 год назад
_tools 643001f9b1 Merge pull request #8450 from Cerno-b/reorganise-about-headers 1 год назад
about 54a4a17b24 Merge pull request #8702 from N3ST0R-byte/patch-2 1 год назад
classes bf7d0c19c3 classref: Sync with current master branch (1ba920f) 1 год назад
community 5966ffdca4 Merge pull request #8364 from JohnSmith757/patch-1 1 год назад
contributing d0286df2ae Merge pull request #8776 from Calinou/update-internal-rendering-architecture 1 год назад
getting_started 1fa0918a7d Merge pull request #7890 from AThousandShips/pos_fix 1 год назад
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 лет назад
tutorials 2a41e90bd9 Merge pull request #8738 from jsjtxietian/patch-3 1 год назад
.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 87ab4cafa5 Fix `/` keyboard shortcut to allow typing `/` within the search field 1 год назад
index.rst 53e837c640 Bump docs version to 4.2 1 год назад
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 лет назад
requirements.txt 1db6e49e0f Pin sphinx-contrib libraries to pre-5.0 version 1 год назад
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.