#godot #docs #howto

Max Hilbrunner 435dea06cf Merge pull request #11217 from Qubus0/better-pygments-gdscript 7 tuntia sitten
.github f875de93e5 Update contributing links to contributing.godotengine.org. 2 päivää sitten
_extensions 5ebeb22bd0 expands the pygments lexer to cover GDScript 2 better 1 viikko sitten
_static 5ebeb22bd0 expands the pygments lexer to cover GDScript 2 better 1 viikko sitten
_styleguides 0855668721 Migrate contributing contents to a separate documentation site. 2 päivää sitten
_templates 0855668721 Migrate contributing contents to a separate documentation site. 2 päivää sitten
_tools f875de93e5 Update contributing links to contributing.godotengine.org. 2 päivää sitten
about faa2eb7951 Update "Contributing" section description in introduction.rst to "Engine details". 2 päivää sitten
classes c8db5ec6e0 classref: Sync with current master branch (bfa330d) 21 tuntia sitten
community a15f86bc03 Merge branch 'master' into patch-1 5 kuukautta sitten
engine_details 4502192cc5 Improve descriptions of `LocalVector`, recommend it when appropriate 1 päivä sitten
getting_started cab0c1cb9e Link to GDExtension articles from the Godot introduction. 1 päivä sitten
img a82ed18d3d Add FoldableContainer to the Control node gallery page 2 kuukautta sitten
tutorials bbb393cfc7 Merge pull request #11201 from stuckupfool/patch-1 21 tuntia 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 965685e247 Add more Python-related files to gitignore 7 kuukautta sitten
.lycheeignore bf27bf2c96 Fix URL check errors 5 kuukautta sitten
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 vuosi sitten
.pre-commit-config.yaml 0855668721 Migrate contributing contents to a separate documentation site. 2 päivää sitten
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 vuotta sitten
404.rst 2bfc2f04cf Hide user notes on 404 page 4 kuukautta sitten
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 vuosi 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 f875de93e5 Update contributing links to contributing.godotengine.org. 2 päivää sitten
conf.py 3cc1b0d979 Bump version 19 tuntia sitten
index.rst 0855668721 Migrate contributing contents to a separate documentation site. 2 päivää sitten
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 vuotta sitten
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 10 kuukautta sitten
requirements.txt 01970e58b2 Bump sphinxext-opengraph from 0.12.0 to 0.13.0 1 viikko 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

To browse the documentation offline, you can download an HTML copy (updated every Monday): stable, latest, 3.6. Extract the ZIP archive then open the top-level index.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. Extract the ZIP archive then open the GodotEngine.epub file in an e-book reader application.

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 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

License

With 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.