Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
Godot
/
godot-docs
zrkadlo https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Súbory Issues 0 Wiki

#godot #docs #howto

Strom: a26b51f306
Branche Tagy
godot-docs
ZIP TAR.GZ
Hugo Locurcio a26b51f306 Fix outdated notice about reflection probes not being supported in Compatibility 4 mesiacov pred
.github 5bf9ef3aa6 CI: Check URLs on schedule only to reduce false positives 4 mesiacov pred
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` 7 mesiacov pred
_static 049b42989e Revert "Fix video alignment after dependency update" 6 mesiacov pred
_styleguides 88970e5daa Add German style guide 1 rok pred
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. 7 mesiacov pred
_tools f70686cdbe CI: Integrate `pre-commit` for style checks 8 mesiacov pred
about f03720228a Fix typo in Release policy 4 mesiacov pred
classes 416fa65fb6 classref: Sync with current master branch (15ff450) 5 mesiacov pred
community 78d2ddb14c Update screenshots and descriptions in Asset Library docs (#10665) 5 mesiacov pred
contributing da75dd1b98 Merge pull request #10763 from Calinou/internal-rendering-architecture-2d-batching 4 mesiacov pred
getting_started eb2b940918 update "Add Library" to "New Library" 4 mesiacov pred
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 11 mesiacov pred
tutorials a26b51f306 Fix outdated notice about reflection probes not being supported in Compatibility 4 mesiacov pred
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitignore 965685e247 Add more Python-related files to gitignore 6 mesiacov pred
.lycheeignore bf27bf2c96 Fix URL check errors 4 mesiacov pred
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 mesiacov pred
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 8 mesiacov pred
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 rokov pred
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 mesiacov pred
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 rokov pred
Makefile 31204023b6 Makefile: use sphinx-build -M 2 rokov pred
README.md d4b2a69cf6 Fix broken link in README to Contributing section 9 mesiacov pred
conf.py 68d7191b39 Add Plausible 6 mesiacov pred
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 1 rok pred
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 rokov pred
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 8 mesiacov pred
requirements.txt 6d037e7f2b Bump sphinxcontrib-video from 0.4.0 to 0.4.1 5 mesiacov pred
robots.txt fd5f6f4909 Appease our great search engine overlords 5 rokov pred

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.