#godot #docs #howto

Marek S. Ł 1cdd6c9cc7 Replace instance diagram images for readability on all backgrounds (#4609) il y a 4 ans
.github aab75310c7 Update PR template il y a 4 ans
_extensions 1f8dcbeee7 Fix Sphinx `add_lexer()` deprecation in the GDScript extension (#4594) il y a 4 ans
_static cbeb9212cc Fix the "ref" badge appearing twice in search results il y a 4 ans
_templates d494d19dac Remove trailing whitespace and irregular whitespace il y a 5 ans
_tools 5e3a7c8fd1 Add a tool to move rst files and images il y a 5 ans
about 1ec802463a Add MP3 to the list of supported audio formats (#4569) il y a 4 ans
classes d0eb1eb6bc Move remaining files out of step_by_step/ il y a 4 ans
community de34df3ecb Add @TheGuideKnight's 2D tutorial series to Tutorials and resources (#4592) il y a 4 ans
development 1a36804d99 Merge pull request #4541 from Calinou/add-editor-development-page il y a 4 ans
getting_started 1cdd6c9cc7 Replace instance diagram images for readability on all backgrounds (#4609) il y a 4 ans
img e1e08419f6 Add a page referencing the Control gallery image and demo il y a 4 ans
tutorials 8d15ca796d Reference Custom Effects property in BBCode in RichTextLabel (#4604) il y a 4 ans
.gitattributes 34f97a7544 GitHub linguist: Mark .rst files as detectable il y a 5 ans
.gitignore 1361ffb70c Add _tools folder for utility scripts il y a 5 ans
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors il y a 5 ans
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 il y a 5 ans
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors il y a 5 ans
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license il y a 6 ans
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial il y a 5 ans
README.md bdeb07691a Fix URL typo in the README (#4415) il y a 4 ans
conf.py bdece44b8d Prevent the compatibility notice from being the `meta description` il y a 5 ans
index.rst 511d28134e Link to DevDocs on the home page for offline browsing il y a 4 ans
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" il y a 5 ans
requirements.txt 45d95db39f Update instant search plugin to a packaged version (#3963) il y a 5 ans
robots.txt fd5f6f4909 Appease our great search engine overlords il y a 5 ans

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.