#godot #docs #howto

Rooni 2bc63a080c Fix indentation on mouse_and_input_coordinates.rst před 10 měsíci
.github edfc55963c Bump peter-evans/create-pull-request from 6 to 7 před 11 měsíci
_extensions 5c4342caa4 Fix keywords for Vector in GDScript syntax highlighting před 11 měsíci
_static 57c24d9b46 Fix scrolling outside of content area před 1 rokem
_styleguides 88970e5daa Add German style guide před 1 rokem
_templates bedd304160 Remove Giscus from search page (#8777) před 1 rokem
_tools 799f39d4b6 Fix redirect to new contribution guidelines před 1 rokem
about 4ac951fe13 Removed unnecessary examples of GDScript usage. před 10 měsíci
classes 28d9cb75e9 classref: Sync with current master branch (76a1359) před 10 měsíci
community 5009868942 Update Discord, refer to website for communities před 11 měsíci
contributing 6010454a38 Merge pull request #9947 from Repiteo/warning-admonition před 10 měsíci
getting_started 7a13592c9c Link to Exporting projects in Finishing up page of Your first 2D game před 10 měsíci
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) před 11 měsíci
tutorials 2bc63a080c Fix indentation on mouse_and_input_coordinates.rst před 10 měsíci
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) před 4 roky
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) před 4 roky
.gitignore 47bacc95fd Added configuring ide for rider (#7420) před 2 roky
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years před 11 měsíci
.readthedocs.yml d9e0d8386e Add tools definition for RTD před 2 roky
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years před 11 měsíci
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license před 6 roky
Makefile 31204023b6 Makefile: use sphinx-build -M před 2 roky
README.md 923fbf2bb6 Update ReadMe file with offline doc options před 1 rokem
conf.py dd9448f725 Bump version před 11 měsíci
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute před 1 rokem
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs před 2 roky
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages před 1 rokem
robots.txt fd5f6f4909 Appease our great search engine overlords před 5 roky

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.