Startsida Utforska Hjälp
Logga in
Godot
/
godot-docs
spegling av https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Filer Ärenden 0 Wiki

#godot #docs #howto

Träd: 31ac9bc227
Grenar Taggar
godot-docs
ZIP TAR.GZ
Max Hilbrunner 31ac9bc227 Merge pull request #7699 from dsnopek/gdextension-4.1-notes 2 år sedan
.github 45c425079f Tell codespell to ignore the locale code page (#7519) 2 år sedan
_extensions 7d5fb4e6a2 Various fixups 2 år sedan
_static b57807b618 Make it possible to read abbreviations by tapping on mobile 2 år sedan
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 2 år sedan
_tools 45c425079f Tell codespell to ignore the locale code page (#7519) 2 år sedan
about 7fc46da582 Merge pull request #7518 from Calinou/release-policy-add-compatibility-policy 2 år sedan
classes f763c64686 classref: Sync with current master branch (6588a4a) 2 år sedan
community 5201efb43e Add text tutorial 2 år sedan
contributing f004b1ac3d Update GitHub Actions UI workflow in Testing pull requests 2 år sedan
getting_started 6f9c56b72b Merge pull request #7676 from Varusal/master 2 år sedan
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 år sedan
tutorials 31ac9bc227 Merge pull request #7699 from dsnopek/gdextension-4.1-notes 2 år sedan
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 år sedan
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 år sedan
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 år sedan
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 år sedan
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 år sedan
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 år sedan
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 år sedan
Makefile 31204023b6 Makefile: use sphinx-build -M 2 år sedan
README.md 9d1dd80374 Build ePubs of the documentation for offline reading 2 år sedan
conf.py 82fac20c98 Update Godot version to 4.2 2 år sedan
index.rst 9d1dd80374 Build ePubs of the documentation for offline reading 2 år sedan
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 år sedan
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting 2 år sedan
robots.txt fd5f6f4909 Appease our great search engine overlords 5 år sedan

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

At 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.