#godot #docs #howto

Hugo Locurcio de6b22cefc Document SSE4.2 instruction set in System requirements 2 ay önce
.github 5bf9ef3aa6 CI: Check URLs on schedule only to reduce false positives 5 ay önce
_extensions 7a7ac7dc2d GDScript: Document abstract and variadic functions 2 ay önce
_static 049b42989e Revert "Fix video alignment after dependency update" 7 ay önce
_styleguides 88970e5daa Add German style guide 1 yıl önce
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. 8 ay önce
_tools 6ad8b84835 Bump requests from 2.32.0 to 2.32.4 in /_tools/redirects 3 ay önce
about de6b22cefc Document SSE4.2 instruction set in System requirements 2 ay önce
classes 5e15d0f969 classref: Sync with current master branch (53be3b7) 2 ay önce
community a15f86bc03 Merge branch 'master' into patch-1 5 ay önce
contributing fa1d5635dd Update custom templates images on compiling pages 2 ay önce
getting_started 1fbfaf5509 Document Flameshot being cross-platform in Learning new features 2 ay önce
img a82ed18d3d Add FoldableContainer to the Control node gallery page 2 ay önce
tutorials 59e5d24008 Merge pull request #11094 from Ayush41/fixed-issue-11090 2 ay önce
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 yıl önce
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 yıl önce
.gitignore 965685e247 Add more Python-related files to gitignore 7 ay önce
.lycheeignore bf27bf2c96 Fix URL check errors 5 ay önce
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 yıl önce
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 10 ay önce
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 yıl önce
404.rst 2bfc2f04cf Hide user notes on 404 page 4 ay önce
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 yıl önce
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 yıl önce
Makefile 31204023b6 Makefile: use sphinx-build -M 2 yıl önce
README.md d4b2a69cf6 Fix broken link in README to Contributing section 10 ay önce
conf.py 2bfc2f04cf Hide user notes on 404 page 4 ay önce
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 1 yıl önce
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 yıl önce
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 10 ay önce
requirements.txt 64e4c1d715 Bump pygments from 2.19.1 to 2.19.2 2 ay önce
robots.txt fd5f6f4909 Appease our great search engine overlords 5 yıl önce

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.