#godot #docs #howto

Max Hilbrunner 658c6de4aa Merge pull request #11127 from skyace65/Advanced-Import-Settings hace 1 día
.github 3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check hace 1 día
_extensions 7a7ac7dc2d GDScript: Document abstract and variadic functions hace 1 mes
_static 6792402014 Add custom Sphinx roles for editor UI hace 3 meses
_styleguides 88970e5daa Add German style guide hace 1 año
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. hace 6 meses
_tools 3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check hace 1 día
about 532a216444 Merge pull request #11103 from Calinou/system-requirements-sse4.2 hace 6 días
classes 77812833de classref: Sync with current master branch (e0603ae) hace 3 días
community a15f86bc03 Merge branch 'master' into patch-1 hace 3 meses
contributing 3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check hace 1 día
getting_started 76cf579d9e Merge pull request #10251 from tetrapod00/custom-role hace 1 semana
img a82ed18d3d Add FoldableContainer to the Control node gallery page hace 2 semanas
tutorials 658c6de4aa Merge pull request #11127 from skyace65/Advanced-Import-Settings hace 1 día
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) hace 4 años
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) hace 4 años
.gitignore 965685e247 Add more Python-related files to gitignore hace 5 meses
.lycheeignore bf27bf2c96 Fix URL check errors hace 4 meses
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years hace 11 meses
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook hace 8 meses
.readthedocs.yml d9e0d8386e Add tools definition for RTD hace 2 años
404.rst 2bfc2f04cf Hide user notes on 404 page hace 2 meses
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years hace 11 meses
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license hace 6 años
Makefile 31204023b6 Makefile: use sphinx-build -M hace 2 años
README.md d4b2a69cf6 Fix broken link in README to Contributing section hace 9 meses
conf.py 76cf579d9e Merge pull request #10251 from tetrapod00/custom-role hace 1 semana
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute hace 1 año
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs hace 2 años
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks hace 8 meses
requirements.txt 64e4c1d715 Bump pygments from 2.19.1 to 2.19.2 hace 1 mes
robots.txt fd5f6f4909 Appease our great search engine overlords hace 5 años

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.