#godot #docs #howto

zacryol c5291196aa Refactor Memory Management section 3 năm trước cách đây
.github 7b35584569 GitHub Actions: Don't build with warnings-as-errors for offline doc 3 năm trước cách đây
_extensions 45c9248c06 Update GDScriptLexer to GDScript 2.0 4 năm trước cách đây
_static 4f67dc3cac Reorganize and update the "BBCode in RichTextLabel" article 4 năm trước cách đây
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 năm trước cách đây
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 năm trước cách đây
about 6c10abd06a Fix `print()` reference in Complying with licenses 3 năm trước cách đây
classes 15f78ae0b9 classref: Update links to documentation pages after reorganization 3 năm trước cách đây
community 81fea66371 Document that `.gdignore` files' contents are ignored 3 năm trước cách đây
development a6c918da85 Compiling: Drop yasm dependency and references to WebM 3 năm trước cách đây
getting_started 82e963b048 Update text concerning collision objects (#5307) 3 năm trước cách đây
img aff48371b2 Add cheatsheet and comparison image for `ease()` and `smoothstep()` 4 năm trước cách đây
tutorials c5291196aa Refactor Memory Management section 3 năm trước cách đây
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 năm trước cách đây
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 năm trước cách đây
.gitignore 1361ffb70c Add _tools folder for utility scripts 5 năm trước cách đây
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 năm trước cách đây
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 năm trước cách đây
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 năm trước cách đây
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 năm trước cách đây
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 năm trước cách đây
README.md 4060179184 Remove trailing space characters (#5251) 4 năm trước cách đây
conf.py 4060179184 Remove trailing space characters (#5251) 4 năm trước cách đây
index.rst 4664df9819 Build offline documentation for the stable branch as well (#4896) 4 năm trước cách đây
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 năm trước cách đây
requirements.txt edc6472797 Bump sphinx-tabs from 3.1.0 to 3.2.0 4 năm trước cách đây
robots.txt fd5f6f4909 Appease our great search engine overlords 5 năm trước cách đây

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. 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.