Strona główna Odkrywaj Pomoc
Zaloguj się
Godot
/
godot-docs
kopia lustrzana https://github.com/godotengine/godot-docs.git
2
0
Forkuj 0
Pliki Problemy 0 Wiki

#godot #docs #howto

Drzewo: 28f839e137
Gałęzie Tagi
godot-docs
ZIP TAR.GZ
Godot Organization 28f839e137 classref: Sync with current master branch (540ea0b) 1 miesiąc temu
.github f875de93e5 Update contributing links to contributing.godotengine.org. 3 miesięcy temu
_extensions ae44232a70 Revert "read classes from file when lexing" 1 miesiąc temu
_static 2d9c2365d4 Fix redirects in safari, by moving the redirect js script into the 404 page instead of checking if we're on 404 via the API. 2 miesięcy temu
_styleguides 0855668721 Migrate contributing contents to a separate documentation site. 3 miesięcy temu
_templates 0855668721 Migrate contributing contents to a separate documentation site. 3 miesięcy temu
_tools e69b689540 Add JavaScript-based redirects to supplement Read the Docs redirects 2 miesięcy temu
about 91e6e63588 Update release policy with info now that 4.5 is released 2 miesięcy temu
classes 28f839e137 classref: Sync with current master branch (540ea0b) 1 miesiąc temu
community a15f86bc03 Merge branch 'master' into patch-1 8 miesięcy temu
engine_details 9a4756d6d1 Recommend building just `compile_commands.json` in the `CLion` documentation. 1 miesiąc temu
getting_started cab0c1cb9e Link to GDExtension articles from the Godot introduction. 3 miesięcy temu
img a82ed18d3d Add FoldableContainer to the Control node gallery page 5 miesięcy temu
tutorials e4d463e746 Update recording_with_microphone.rst for iOS audio settings (#11380) 1 miesiąc temu
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 lat temu
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 lat temu
.gitignore 965685e247 Add more Python-related files to gitignore 10 miesięcy temu
.lycheeignore bf27bf2c96 Fix URL check errors 8 miesięcy temu
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 rok temu
.pre-commit-config.yaml 0855668721 Migrate contributing contents to a separate documentation site. 3 miesięcy temu
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 lat temu
404.rst 1ffd71c5e7 Fix RTD language switcher redirecting to nonexistent `/en/4.x/` branch 2 miesięcy temu
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 rok temu
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 7 lat temu
Makefile 31204023b6 Makefile: use sphinx-build -M 2 lat temu
README.md f875de93e5 Update contributing links to contributing.godotengine.org. 3 miesięcy temu
conf.py 3cc1b0d979 Bump version 3 miesięcy temu
index.rst 0855668721 Migrate contributing contents to a separate documentation site. 3 miesięcy temu
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 lat temu
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 1 rok temu
requirements.txt 01970e58b2 Bump sphinxext-opengraph from 0.12.0 to 0.13.0 3 miesięcy temu
robots.txt fd5f6f4909 Appease our great search engine overlords 5 lat temu

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