#godot #docs #howto

Hugo Locurcio 721603d902 Merge pull request #10714 from Calinou/custom-postprocessing-update-anchors 5 ماه پیش
.github 51a597f7b6 GitHub Actions: Check URLs using lychee 5 ماه پیش
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` 7 ماه پیش
_static 049b42989e Revert "Fix video alignment after dependency update" 6 ماه پیش
_styleguides 88970e5daa Add German style guide 1 سال پیش
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. 7 ماه پیش
_tools f70686cdbe CI: Integrate `pre-commit` for style checks 8 ماه پیش
about 048bb2775e Update links to C# and GDScript sections 5 ماه پیش
classes e0d64a53bd classref: Sync with current master branch (394508d) 5 ماه پیش
community 78d2ddb14c Update screenshots and descriptions in Asset Library docs (#10665) 5 ماه پیش
contributing b884bfe10b Merge pull request #8620 from hugarty/patch-2 5 ماه پیش
getting_started 91da8dd9d1 Merge pull request #10687 from skyace65/3DGameSetup 5 ماه پیش
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 11 ماه پیش
tutorials 721603d902 Merge pull request #10714 from Calinou/custom-postprocessing-update-anchors 5 ماه پیش
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 سال پیش
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 سال پیش
.gitignore 965685e247 Add more Python-related files to gitignore 6 ماه پیش
.lycheeignore 51a597f7b6 GitHub Actions: Check URLs using lychee 5 ماه پیش
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 ماه پیش
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 8 ماه پیش
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 سال پیش
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 ماه پیش
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 سال پیش
Makefile 31204023b6 Makefile: use sphinx-build -M 2 سال پیش
README.md d4b2a69cf6 Fix broken link in README to Contributing section 9 ماه پیش
conf.py 68d7191b39 Add Plausible 6 ماه پیش
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 1 سال پیش
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 سال پیش
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 8 ماه پیش
requirements.txt 6d037e7f2b Bump sphinxcontrib-video from 0.4.0 to 0.4.1 5 ماه پیش
robots.txt fd5f6f4909 Appease our great search engine overlords 5 سال پیش

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.