Home Verkennen Help
Inloggen
Godot
/
godot-docs
spiegel van https://github.com/godotengine/godot-docs.git
2
0
Vork 0
Bestanden Issues 0 Wiki

#godot #docs #howto

Boom: f54bb92faa
Aftakkingen Labels
godot-docs
ZIP TAR.GZ
Hugo Locurcio f54bb92faa Fix decals demo link in Using decals 1 jaar geleden
.github 82292025d9 Update codespell path and fix spelling errors 1 jaar geleden
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 jaar geleden
_static 57c24d9b46 Fix scrolling outside of content area 1 jaar geleden
_styleguides 88970e5daa Add German style guide 1 jaar geleden
_templates bedd304160 Remove Giscus from search page (#8777) 1 jaar geleden
_tools 799f39d4b6 Fix redirect to new contribution guidelines 1 jaar geleden
about e09439a4e0 Add missing C# code examples to documentation 1 jaar geleden
classes e0628f0a0d classref: Sync with current master branch (e3550cb) 1 jaar geleden
community b08d7fea84 First look at editor's interface iteration 1 jaar geleden
contributing 728eb341fa [Contributing] Improve list of classes disabled by `disable_advanced_gui` 1 jaar geleden
getting_started 124742666b Update 18_register_autoload.webp 1 jaar geleden
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 1 jaar geleden
tutorials f54bb92faa Fix decals demo link in Using decals 1 jaar geleden
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 jaren geleden
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 jaren geleden
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 jaren geleden
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 jaar geleden
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 jaren geleden
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 jaar geleden
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 jaren geleden
Makefile 31204023b6 Makefile: use sphinx-build -M 2 jaren geleden
README.md 923fbf2bb6 Update ReadMe file with offline doc options 1 jaar geleden
conf.py dd9448f725 Bump version 1 jaar geleden
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 1 jaar geleden
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 jaren geleden
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages 1 jaar geleden
robots.txt fd5f6f4909 Appease our great search engine overlords 5 jaren geleden

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.