#godot #docs #howto

Hugo Locurcio 4ba5a42f9c Fix NDC coordinates for Vulkan in Advanced post-processing 3 vuotta sitten
.github ea22e98cee Update issue template with links to doc tutorials (#4573) 4 vuotta sitten
_extensions 45c9248c06 Update GDScriptLexer to GDScript 2.0 4 vuotta sitten
_static 4f67dc3cac Reorganize and update the "BBCode in RichTextLabel" article 3 vuotta sitten
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 vuotta sitten
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 vuotta sitten
about f057ffdd92 Merge pull request #5235 from Calinou/release-policy-3.4-q4 3 vuotta sitten
classes 38896d8716 Hide "Edit on GitHub" link on the class reference TOC page (#5141) 4 vuotta sitten
community 63a26da749 Merge pull request #5240 from Calinou/cpp-guidelines-3.x-restrictions 3 vuotta sitten
development f581264b70 Document a workaround for testing scripts without test() (#5257) 3 vuotta sitten
getting_started 5c7f653347 Optimize PNG and SVG images using oxipng and svgcleaner (#5254) 3 vuotta sitten
img 5c7f653347 Optimize PNG and SVG images using oxipng and svgcleaner (#5254) 3 vuotta sitten
tutorials 4ba5a42f9c Fix NDC coordinates for Vulkan in Advanced post-processing 3 vuotta sitten
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 vuotta sitten
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 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 4060179184 Remove trailing space characters (#5251) 3 vuotta sitten
conf.py 4060179184 Remove trailing space characters (#5251) 3 vuotta sitten
index.rst 4664df9819 Build offline documentation for the stable branch as well (#4896) 4 vuotta sitten
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 vuotta sitten
requirements.txt edc6472797 Bump sphinx-tabs from 3.1.0 to 3.2.0 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.

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.