#godot #docs #howto

Justin McGettigan 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 vuotta sitten
.github 5f64430148 [ci] use Makefile 2 vuotta sitten
_extensions 7d5fb4e6a2 Various fixups 2 vuotta sitten
_static 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 vuotta sitten
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 2 vuotta sitten
_tools 1b0310aa47 Fix typos and make CI a happy Gobot 2 vuotta sitten
about f4efa2fd8a Move rationale about Godot using SCons to Frequently asked questions 2 vuotta sitten
classes fb93c04226 classref: Sync with 4.0-stable 2 vuotta sitten
community 08498ef96a Change capitalization of Project Manager 2 vuotta sitten
contributing 5eb4a277c4 Fix typo 'adominitions' 2 vuotta sitten
getting_started 4d525171fa Add macOS shortcut for closing Scene window 2 vuotta sitten
img 3dfbfbf381 Add links to demo projects where relevant (#6874) 2 vuotta sitten
tutorials c8e345dd1b Merge pull request #7169 from Calinou/add-physics-troubleshooting 2 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 bc925e0c80 Made a sentence easier to read and included a reference to class_String (#7034) 2 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 5175fb8256 Use official CC BY 3.0 terminology and resources 2 vuotta sitten
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 vuotta sitten
Makefile 31204023b6 Makefile: use sphinx-build -M 2 vuotta sitten
README.md 0500f4df7c Update links in README to fix broken URLs (#6589) 2 vuotta sitten
conf.py 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 vuotta sitten
index.rst d524544e07 Improve naming and organization of some manual articles 2 vuotta sitten
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 vuotta sitten
requirements.txt 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 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. Building the manual
  6. 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.