#godot #docs #howto

Max Hilbrunner 4be450c9ce Merge pull request #10152 from Calinou/autoload-get-child-negative-index преди 10 месеца
.github edfc55963c Bump peter-evans/create-pull-request from 6 to 7 преди 1 година
_extensions 5c4342caa4 Fix keywords for Vector in GDScript syntax highlighting преди 1 година
_static 57c24d9b46 Fix scrolling outside of content area преди 1 година
_styleguides 88970e5daa Add German style guide преди 1 година
_templates bedd304160 Remove Giscus from search page (#8777) преди 1 година
_tools d8af389550 Remove Blender ESCN exporter pages. преди 11 месеца
about 49a6517ef4 Update Release Policy for release of 3.6 преди 11 месеца
classes 85ce5bdfd1 classref: Sync with current master branch (61accf0) преди 10 месеца
community 31723d8fcf Remove note in Submitting to Asset Library преди 11 месеца
contributing ca96e45453 Removed unnecessary note, as this page got rid of "$" signs in below commit: преди 11 месеца
getting_started a9a2cd1a20 Tweak note about making Physics Material unique in Creating instances преди 11 месеца
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) преди 1 година
tutorials 748775370a Use negative index for `get_child()` in Singletons (Autoload) преди 10 месеца
.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 47bacc95fd Added configuring ide for rider (#7420) преди 2 години
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years преди 1 година
.readthedocs.yml d9e0d8386e Add tools definition for RTD преди 2 години
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years преди 1 година
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license преди 6 години
Makefile 31204023b6 Makefile: use sphinx-build -M преди 2 години
README.md 923fbf2bb6 Update ReadMe file with offline doc options преди 1 година
conf.py dd9448f725 Bump version преди 1 година
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute преди 1 година
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs преди 2 години
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages преди 1 година
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.