Repository files navigation

This repository contains the source files ofGodot Engine's documentation, in reStructuredText markup language (reST).

They are meant to be parsed with theSphinx documentation builder to build the HTML documentation onGodot's website.

To browse the documentation offline, you can download an HTML copy (updated every Monday):stable,latest,3.6. Extractthe ZIP archive then open the top-levelindex.html in a web browser.

For mobile devices or e-readers, you can also download an ePub copy (updated every Monday):stable,latest,3.6. Extractthe ZIP archive then open theGodotEngine.epub file in an e-book reader application.

The Godot documentation uses the defaultsphinx_rtd_theme with manycustomizations applied on top. It will automatically switch betweenthe 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 OSconfiguration, you can install theDark Website Forceradd-on.

All contributors are welcome to help on the Godot documentation.

To get started, head to theContributing documentation. 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. Building the manual
6. Translating the documentation

With the exception of theclasses/ 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".SeeLICENSE.txt for details.

The files in theclasses/ folder are derived fromGodot's main source repository and are distributed under the MIT license, with the same authors as above.