Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
Godot
/
godot-docs
zrkadlo https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Súbory Issues 0 Wiki

#godot #docs #howto

Strom: 6fac7f0d8d
Branche Tagy
godot-docs
ZIP TAR.GZ
Thakee Nathees 6fac7f0d8d documentation for the GDScript documentation comments 5 rokov pred
.github b1b0ca4e4c Check for updates to GitHub Actions every weekday 4 rokov pred
_extensions 7b60dd1794 Escape double quotes for meta descriptions in HTML 4 rokov pred
_static cbeb9212cc Fix the "ref" badge appearing twice in search results 4 rokov pred
_templates d494d19dac Remove trailing whitespace and irregular whitespace 5 rokov pred
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 rokov pred
about d0eb1eb6bc Move remaining files out of step_by_step/ 4 rokov pred
classes d0eb1eb6bc Move remaining files out of step_by_step/ 4 rokov pred
community 5d6aff1fb9 Fix list formatting and outdated information in Ways to contribute 4 rokov pred
development 5cfdce49ab Document using `nproc` instead of hardcoded number of threads (#4476) 4 rokov pred
getting_started a9a0e99fef Fix Hide() in _ready() first player example code 4 rokov pred
img d585cf540e Add a preview image of Color constants by @theowiik 4 rokov pred
tutorials 6fac7f0d8d documentation for the GDScript documentation comments 4 rokov pred
.gitattributes 34f97a7544 GitHub linguist: Mark .rst files as detectable 5 rokov pred
.gitignore 1361ffb70c Add _tools folder for utility scripts 5 rokov pred
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 rokov pred
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 rokov pred
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 rokov pred
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 rokov pred
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 rokov pred
README.md bdeb07691a Fix URL typo in the README (#4415) 4 rokov pred
conf.py bdece44b8d Prevent the compatibility notice from being the `meta description` 4 rokov pred
index.rst e32454978c Write the first three parts of the 3D tutorial 4 rokov pred
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 rokov pred
requirements.txt 45d95db39f Update instant search plugin to a packaged version (#3963) 4 rokov pred
robots.txt fd5f6f4909 Appease our great search engine overlords 5 rokov pred

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.