#godot #docs #howto

Matthew c430348c05 Merge pull request #10709 from Calinou/resolution-scaling-mention-renderers hai 7 meses
.github 51a597f7b6 GitHub Actions: Check URLs using lychee hai 7 meses
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` hai 9 meses
_static 049b42989e Revert "Fix video alignment after dependency update" hai 7 meses
_styleguides 88970e5daa Add German style guide hai 1 ano
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. hai 8 meses
_tools f70686cdbe CI: Integrate `pre-commit` for style checks hai 10 meses
about 048bb2775e Update links to C# and GDScript sections hai 7 meses
classes e0d64a53bd classref: Sync with current master branch (394508d) hai 7 meses
community 78d2ddb14c Update screenshots and descriptions in Asset Library docs (#10665) hai 7 meses
contributing b884bfe10b Merge pull request #8620 from hugarty/patch-2 hai 7 meses
getting_started 59a53252ec Merge pull request #10659 from tetrapod00/doc-not-toc hai 7 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 aec34d67ad Mention renderer limitations in Resolution scaling hai 7 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 7 meses
.lycheeignore 51a597f7b6 GitHub Actions: Check URLs using lychee hai 7 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 10 meses
.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=6) %!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 10 meses
conf.py 68d7191b39 Add Plausible hai 7 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 10 meses
requirements.txt 6d037e7f2b Bump sphinxcontrib-video from 0.4.0 to 0.4.1 hai 7 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.