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: a40e4fd10a
Grenar Taggar
godot-docs
ZIP TAR.GZ
Max Hilbrunner a40e4fd10a Merge pull request #7199 from Calinou/custom-mouse-cursor-update-max-size 2 år sedan
.github cde5e82a65 Fix CI comment 2 år sedan
_extensions 7d5fb4e6a2 Various fixups 2 år sedan
_static 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 år sedan
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 2 år sedan
_tools 1b0310aa47 Fix typos and make CI a happy Gobot 2 år sedan
about de7687fa3f Document how to resolve issues with the editor looking too sharp or blurry 2 år sedan
classes fb93c04226 classref: Sync with 4.0-stable 2 år sedan
community 3a7e86f77e Gwizz YT Channel Added 2 år sedan
contributing e7cd5e5a92 [contributing/documentation/building_the_manual] fix headings 2 år sedan
getting_started c6f35d11e7 Merge pull request #7171 from royzwambag/instancing-docs-update 2 år sedan
img 3dfbfbf381 Add links to demo projects where relevant (#6874) 2 år sedan
tutorials 1bd3513507 Mention maximum recommended size of 128×128 in Customizing the mouse cursor 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 bc925e0c80 Made a sentence easier to read and included a reference to class_String (#7034) 2 år sedan
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 år sedan
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 å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 0500f4df7c Update links in README to fix broken URLs (#6589) 2 år sedan
conf.py 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 år sedan
index.rst d524544e07 Improve naming and organization of some manual articles 2 år sedan
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 år sedan
requirements.txt 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 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

You can 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.

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.