#godot #docs #howto

tetrapod d3a902e2d8 Add GitHub Action to automatically create cherrypick PRs (#10361) 8 meses atrás
.github d3a902e2d8 Add GitHub Action to automatically create cherrypick PRs (#10361) 8 meses atrás
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` 8 meses atrás
_static 0da4dbe145 Add self links to shader functions page 9 meses atrás
_styleguides 88970e5daa Add German style guide 1 ano atrás
_templates f47af1fb9e Only show warning box if page is outdated 9 meses atrás
_tools f70686cdbe CI: Integrate `pre-commit` for style checks 10 meses atrás
about c4d3aa134a Standardize RST header syntax 8 meses atrás
classes 7704954857 classref: Sync with current master branch (99a8ab7) 8 meses atrás
community e7cea212a4 Merge pull request #10459 from tetrapod00/typo-tutorials 8 meses atrás
contributing 73d92a8c3e Merge pull request #10439 from 0HyperCube/fedora-embree 8 meses atrás
getting_started c01bcad47e "first 2D game" - minor additions, clarification when areas of the editor are first mentioned (#10378) 8 meses atrás
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 1 ano atrás
tutorials 70a32c6950 Merge pull request #10261 from tetrapod00/improve-uniform 8 meses atrás
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 anos atrás
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 anos atrás
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 anos atrás
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 ano atrás
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 9 meses atrás
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 anos atrás
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 ano atrás
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 anos atrás
Makefile 31204023b6 Makefile: use sphinx-build -M 2 anos atrás
README.md d4b2a69cf6 Fix broken link in README to Contributing section 10 meses atrás
conf.py 2cbe8488d4 Update broken link to RTD docs in comment 9 meses atrás
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 1 ano atrás
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 anos atrás
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 10 meses atrás
requirements.txt 640e434cb5 Bump sphinxcontrib-video from 0.3.1 to 0.3.2 8 meses atrás
robots.txt fd5f6f4909 Appease our great search engine overlords 5 anos atrás

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.