#godot #docs #howto

smix8 5cbff38341 Add missing Navigation category 3 年之前
.github 67feb37d5c Bump actions/upload-artifact from 2 to 3 3 年之前
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 年之前
_static c9d554b3c7 Fix toctree expand icon colors and margins in the theme 3 年之前
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 年之前
_tools ceb405067a Fix RTD redirects 3 年之前
about 2ed7e26fae Fix code literal syntax in FAQ 3 年之前
classes c80ee83362 classref: Sync with latest 4.0-alpha 3 年之前
community 490c2ac988 Add command to build specific files in Building the manual with Sphinx (#5828) 3 年之前
development c1b7505ef8 Update Custom Modules Latest to include header and class name changes. (#5205) 3 年之前
getting_started 9c69e628ba Fix typo: "intantiated" -> "instantiated" (#5810) 3 年之前
img 65345e94ee Update vector2_angle_to_point.png 3 年之前
tutorials 5cbff38341 Add missing Navigation category 3 年之前
.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 ad6846b80e ReadTheDocs redirect automation. 3 年之前
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 年之前
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 年之前
AUTHORS.md c7144215ef Fix formatting on AUTHORS.md file 3 年之前
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 年之前
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 年之前
README.md 4060179184 Remove trailing space characters (#5251) 4 年之前
conf.py a0af6b9df1 Updated the Lincense to match the current year 3 年之前
index.rst 5cbff38341 Add missing Navigation category 3 年之前
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 年之前
requirements.txt 88e9253fd0 Bump sphinxext-opengraph from 0.6.2 to 0.6.3 3 年之前
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

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.