#godot #docs #howto

Hugo Locurcio aa1eb7e77d Add a notice to explain the purpose of the top-level `img/` folder 4 vuotta sitten
.github aab75310c7 Update PR template 4 vuotta sitten
_extensions cf655aa176 Revert "Fix Sphinx `add_lexer()` deprecation in the GDScript extension (#4594)" 4 vuotta sitten
_static cbeb9212cc Fix the "ref" badge appearing twice in search results 4 vuotta sitten
_templates d494d19dac Remove trailing whitespace and irregular whitespace 5 vuotta sitten
_tools 5e3a7c8fd1 Add a tool to move rst files and images 5 vuotta sitten
about 761592598f Remove mentions of IRC in favor of the new Contributors Chat platform (#4644) 4 vuotta sitten
classes d0eb1eb6bc Move remaining files out of step_by_step/ 4 vuotta sitten
community 761592598f Remove mentions of IRC in favor of the new Contributors Chat platform (#4644) 4 vuotta sitten
development c1faa5d976 Update instructions for compiling for Android (#4521) 4 vuotta sitten
getting_started 1cdd6c9cc7 Replace instance diagram images for readability on all backgrounds (#4609) 4 vuotta sitten
img aa1eb7e77d Add a notice to explain the purpose of the top-level `img/` folder 4 vuotta sitten
tutorials 1c8ae020a8 Merge pull request #4560 from aaronfranke/cs-setup 4 vuotta sitten
.gitattributes 34f97a7544 GitHub linguist: Mark .rst files as detectable 5 vuotta sitten
.gitignore 1361ffb70c Add _tools folder for utility scripts 5 vuotta sitten
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 vuotta sitten
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 vuotta sitten
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 vuotta sitten
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 vuotta sitten
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 vuotta sitten
README.md bdeb07691a Fix URL typo in the README (#4415) 4 vuotta sitten
conf.py f528a844d6 Add a more descriptive custom 404 error page (#4624) 4 vuotta sitten
index.rst 761592598f Remove mentions of IRC in favor of the new Contributors Chat platform (#4644) 4 vuotta sitten
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 vuotta sitten
requirements.txt f528a844d6 Add a more descriptive custom 404 error page (#4624) 4 vuotta sitten
robots.txt fd5f6f4909 Appease our great search engine overlords 5 vuotta sitten

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.