Home Verkennen Help
Inloggen
Godot
/
godot-docs
spiegel van https://github.com/godotengine/godot-docs.git
2
0
Vork 0
Bestanden Issues 0 Wiki

#godot #docs #howto

Boom: aaae2c47cf
Aftakkingen Labels
godot-docs
ZIP TAR.GZ
skyace65 aaae2c47cf Add audio stream player images 4 jaren geleden
.github ea22e98cee Update issue template with links to doc tutorials (#4573) 4 jaren geleden
_extensions 45c9248c06 Update GDScriptLexer to GDScript 2.0 4 jaren geleden
_static e6e87982de Fix styling for keyboard shortcuts 4 jaren geleden
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 jaren geleden
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 jaren geleden
about 56b5246621 Fix GLSL hyperlink formatting in List of features (#5095) 4 jaren geleden
classes 20bcd1307a [Complex Text Layouts] Update tutorials and documentation to match TextServer changes. 4 jaren geleden
community f035fe9e20 Add a .gitattributes recommendation to the AssetLib guidelines 4 jaren geleden
development f1b05afd19 Add Windows configuration example for VS Code 4 jaren geleden
getting_started bd19917ea0 Draft: Remove "simple", "simply", "easy", and "just" from the docs (#4496) 4 jaren geleden
img 4ed76436c8 Add an image for Camera3D is_position_behind and is_position_in_frustum (#4883) 4 jaren geleden
tutorials aaae2c47cf Add audio stream player images 4 jaren geleden
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 jaren geleden
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 jaren geleden
.gitignore 1361ffb70c Add _tools folder for utility scripts 5 jaren geleden
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 jaren geleden
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 jaren geleden
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 jaren geleden
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 jaren geleden
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 jaren geleden
README.md 4664df9819 Build offline documentation for the stable branch as well (#4896) 4 jaren geleden
conf.py 50edc681f9 Add dev.css override 4 jaren geleden
index.rst 4664df9819 Build offline documentation for the stable branch as well (#4896) 4 jaren geleden
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 jaren geleden
requirements.txt 5a3954c465 Remove update block from sphinx-tabs extension 4 jaren geleden
robots.txt fd5f6f4909 Appease our great search engine overlords 5 jaren geleden

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.