#godot #docs #howto

Mark Wilson 8b1a1b644c Improved style for cross-language examples. пре 1 година
.github 70f703a6c8 Update Sphinx version пре 8 месеци
_extensions b09ab6fef9 Fix keywords for Vector in GDScript syntax highlighting пре 10 месеци
_static 70f703a6c8 Update Sphinx version пре 8 месеци
_styleguides 88970e5daa Add German style guide пре 1 година
_templates 097c7ecbcc Remove canonical/hreflang tags, let RTD I18N do it пре 8 месеци
_tools 70969b116d Add custom codespell dictionary пре 8 месеци
about 70969b116d Add custom codespell dictionary пре 8 месеци
classes d93d120bb0 classref: Sync with current 4.3 branch (6699ae7) пре 10 месеци
community 40bdaac499 Remove note in Submitting to Asset Library пре 8 месеци
contributing 302aa47496 Improve Bug triage guidelines пре 8 месеци
getting_started 5b73d7034c Fix typo in Using signals (#10246) пре 8 месеци
img 1586144704 Improve color constants cheat sheet (#8569) пре 1 година
tutorials 8b1a1b644c Improved style for cross-language examples. пре 8 месеци
.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 пре 11 месеци
.readthedocs.yml d9e0d8386e Add tools definition for RTD пре 2 година
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years пре 11 месеци
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 70f703a6c8 Update Sphinx version пре 8 месеци
index.rst 521d6749bc Branch docs version 4.3 пре 11 месеци
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs пре 2 година
requirements.txt 70f703a6c8 Update Sphinx version пре 8 месеци
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.