#godot #docs #howto

Hugo Locurcio a922efa2a8 Add an Using the web editor page (#4629) 4 лет назад
.github aab75310c7 Update PR template 4 лет назад
_extensions cf655aa176 Revert "Fix Sphinx `add_lexer()` deprecation in the GDScript extension (#4594)" 4 лет назад
_static cbeb9212cc Fix the "ref" badge appearing twice in search results 4 лет назад
_templates d494d19dac Remove trailing whitespace and irregular whitespace 5 лет назад
_tools 5e3a7c8fd1 Add a tool to move rst files and images 5 лет назад
about a922efa2a8 Add an Using the web editor page (#4629) 4 лет назад
classes d0eb1eb6bc Move remaining files out of step_by_step/ 4 лет назад
community 761592598f Remove mentions of IRC in favor of the new Contributors Chat platform (#4644) 4 лет назад
development c1faa5d976 Update instructions for compiling for Android (#4521) 4 лет назад
getting_started 1cdd6c9cc7 Replace instance diagram images for readability on all backgrounds (#4609) 4 лет назад
img 33fd43e706 Add images for Vector2's angle methods (#4678) 4 лет назад
tutorials a922efa2a8 Add an Using the web editor page (#4629) 4 лет назад
.gitattributes 34f97a7544 GitHub linguist: Mark .rst files as detectable 5 лет назад
.gitignore 1361ffb70c Add _tools folder for utility scripts 5 лет назад
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 лет назад
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 лет назад
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 лет назад
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 bdeb07691a Fix URL typo in the README (#4415) 4 лет назад
conf.py f528a844d6 Add a more descriptive custom 404 error page (#4624) 4 лет назад
index.rst 761592598f Remove mentions of IRC in favor of the new Contributors Chat platform (#4644) 4 лет назад
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 лет назад
requirements.txt f528a844d6 Add a more descriptive custom 404 error page (#4624) 4 лет назад
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.

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.