Почетна Преглед Помоћ
Пријавите се
Godot
/
godot-docs
огледало од https://github.com/godotengine/godot-docs.git
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики

#godot #docs #howto

Дрво: d56905c94e
Гране Ознаке
godot-docs
ZIP TAR.GZ
Max Hilbrunner d56905c94e Merge pull request #9819 from AThousandShips/proposal_instruction пре 1 година
.github 271d4ffbde Add link to `godot-proposals` in the issue template пре 1 година
_extensions 0a01baec10 Fix epub-related failures (#8207) пре 1 година
_static 57c24d9b46 Fix scrolling outside of content area пре 1 година
_styleguides 88970e5daa Add German style guide пре 1 година
_templates bedd304160 Remove Giscus from search page (#8777) пре 1 година
_tools 799f39d4b6 Fix redirect to new contribution guidelines пре 1 година
about ea604c400e Update release policy information on Godot 4.3 (#9755) пре 1 година
classes 5a25f5357e classref: Sync with current master branch (1bd740d) пре 1 година
community b08d7fea84 First look at editor's interface iteration пре 1 година
contributing 13759251c8 Merge pull request #9796 from esainane/no-comment пре 1 година
getting_started 124742666b Update 18_register_autoload.webp пре 1 година
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) пре 1 година
tutorials 88d2383eb1 Merge pull request #9804 from ShawnHardern/update-viewports-examples-csharp пре 1 година
.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 пре 1 година
.readthedocs.yml d9e0d8386e Add tools definition for RTD пре 2 година
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years пре 1 година
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 dd9448f725 Bump version пре 1 година
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute пре 1 година
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs пре 2 година
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages пре 1 година
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.