#godot #docs #howto

tetrapod fd34a007ba Merge pull request #10624 from Vocco/fix-process-signature hai 10 meses
.github 2d30a6940c Merge pull request #10583 from mhilbrunner/gh-2404-imagemagick hai 10 meses
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` hai 11 meses
_static 049b42989e Revert "Fix video alignment after dependency update" hai 10 meses
_styleguides 88970e5daa Add German style guide %!s(int64=2) %!d(string=hai) anos
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. hai 11 meses
_tools f70686cdbe CI: Integrate `pre-commit` for style checks hai 1 ano
about c4d3aa134a Standardize RST header syntax hai 11 meses
classes 1c1e1c11bb classref: Sync with current master branch (1586c56) hai 10 meses
community e7cea212a4 Merge pull request #10459 from tetrapod00/typo-tutorials hai 11 meses
contributing 39bbba660d Fix video alignment after dependency update without CSS hai 10 meses
getting_started 7d34e4e42e Clarify difference between Godot's scene instancing and hardware instancing hai 10 meses
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) hai 1 ano
tutorials ff89b4611e Fix C# _Process method signatures hai 10 meses
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) %!s(int64=4) %!d(string=hai) anos
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) %!s(int64=4) %!d(string=hai) anos
.gitignore 965685e247 Add more Python-related files to gitignore hai 10 meses
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years hai 1 ano
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook hai 1 ano
.readthedocs.yml d9e0d8386e Add tools definition for RTD %!s(int64=2) %!d(string=hai) anos
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years hai 1 ano
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license %!s(int64=7) %!d(string=hai) anos
Makefile 31204023b6 Makefile: use sphinx-build -M %!s(int64=2) %!d(string=hai) anos
README.md d4b2a69cf6 Fix broken link in README to Contributing section hai 1 ano
conf.py 68d7191b39 Add Plausible hai 10 meses
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute hai 1 ano
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs %!s(int64=2) %!d(string=hai) anos
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks hai 1 ano
requirements.txt c6fdf264db Bump sphinx-notfound-page from 1.0.4 to 1.1.0 hai 10 meses
robots.txt fd5f6f4909 Appease our great search engine overlords %!s(int64=5) %!d(string=hai) anos

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

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.