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

#godot #docs #howto

ИН на ревизия: 0234b06468
Клонове Маркери
godot-docs
ZIP TAR.GZ
Hugo Locurcio 0234b06468 Apply suggestions from code review преди 4 години
.github 6740682341 Dependabot: Ignore Sphinx upgrades due to ReadTheDocs on v1 (#4486) преди 4 години
_extensions 7b60dd1794 Escape double quotes for meta descriptions in HTML преди 5 години
_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 d0eb1eb6bc Move remaining files out of step_by_step/ преди 4 години
classes d0eb1eb6bc Move remaining files out of step_by_step/ преди 4 години
community ac055fc0b2 CLion setup: Reference clang-format alternative (#4492) преди 4 години
development f3586d755a CLion setup: Update path and screenshot for `CMakeLists.txt` (#4490) преди 4 години
getting_started a9a0e99fef Fix Hide() in _ready() first player example code преди 4 години
img d585cf540e Add a preview image of Color constants by @theowiik преди 5 години
tutorials 0234b06468 Apply suggestions from code review преди 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 bdece44b8d Prevent the compatibility notice from being the `meta description` преди 5 години
index.rst e32454978c Write the first three parts of the 3D tutorial преди 4 години
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" преди 5 години
requirements.txt 45d95db39f Update instant search plugin to a packaged version (#3963) преди 5 години
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.