#godot #docs #howto

Matthew bbb18a1cc5 Merge pull request #8832 from kylestarr/patch-2 il y a 1 an
.github 1ec0392dff Merge pull request #8627 from godotengine/dependabot/github_actions/actions/upload-artifact-4 il y a 1 an
_extensions 0a01baec10 Fix epub-related failures (#8207) il y a 1 an
_static 2526852231 Use Montserrat font for headings to match godotengine.org il y a 1 an
_styleguides 88970e5daa Add German style guide il y a 1 an
_templates 0a01baec10 Fix epub-related failures (#8207) il y a 1 an
_tools 8d9af1aa97 Merge pull request #9260 from melquiadess/fix-typos il y a 1 an
about 45b083c178 Merge pull request #9195 from mh114/patch-1 il y a 1 an
classes e43e650135 classref: Sync with current 4.2 branch (7a3a36a) il y a 1 an
community e9eb6ec89d Merge pull request #8825 from mhilbrunner/update-community-channels il y a 1 an
contributing a8ad17dd10 [Web] Expand "Interacting with Javascript" il y a 1 an
getting_started bbb18a1cc5 Merge pull request #8832 from kylestarr/patch-2 il y a 1 an
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) il y a 2 ans
tutorials e7ab8017e9 Merge pull request #9006 from alitnk/patch-1 il y a 1 an
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) il y a 4 ans
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) il y a 4 ans
.gitignore 47bacc95fd Added configuring ide for rider (#7420) il y a 2 ans
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors il y a 5 ans
.readthedocs.yml d9e0d8386e Add tools definition for RTD il y a 2 ans
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources il y a 3 ans
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license il y a 6 ans
Makefile 31204023b6 Makefile: use sphinx-build -M il y a 2 ans
README.md 8d9af1aa97 Merge pull request #9260 from melquiadess/fix-typos il y a 1 an
conf.py 87ab4cafa5 Fix `/` keyboard shortcut to allow typing `/` within the search field il y a 1 an
index.rst 0f7eaa9dae Added separate links to stable/latest/3.6 copies of the offline documentation il y a 1 an
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs il y a 2 ans
requirements.txt 1db6e49e0f Pin sphinx-contrib libraries to pre-5.0 version il y a 1 an
robots.txt fd5f6f4909 Appease our great search engine overlords il y a 5 ans

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 use the mirror of the documentation hosted on DevDocs. To enable offline browsing on DevDocs, you need to:

  • Click the three dots in the top-left corner, choose Preferences.
  • Enable the desired version of the Godot documentation by checking the box next to it in the sidebar.
  • Click the three dots in the top-left corner, choose Offline data.
  • Click the Install link next to the Godot documentation.

You can also download an HTML copy for offline reading (updated every Monday). 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 for offline reading (updated every Monday). 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.