#godot #docs #howto

Matthew 65042a38f0 Merge pull request #11705 from Orphaeus/patch-1 пре 8 часа
.github 8ffa5d168d Merge pull request #11482 from godotengine/dependabot/github_actions/actions/checkout-6 пре 1 месец
_extensions 7626bd972a Use 4 CPUs on readthedocs by injection. пре 5 дана
_static 71982294e5 Merge pull request #11646 from Calinou/improve-theme-4.6 пре 1 недеља
_styleguides 0855668721 Migrate contributing contents to a separate documentation site. пре 4 месеци
_templates 0855668721 Migrate contributing contents to a separate documentation site. пре 4 месеци
_tools e69b689540 Add JavaScript-based redirects to supplement Read the Docs redirects пре 3 месеци
about 336488b9fd Add a page on creating desktop/mobile/web applications with Godot (#11606) пре 5 дана
classes c85ee01c9c classref: Sync with current master branch (ebbdef7) пре 6 дана
community e5bd72825a Replace Harvard course recommendation with Learn GDScript from Zero пре 2 месеци
engine_details befb129411 Merge pull request #11691 from Lil-Sassy/patch-1 пре 1 дан
getting_started 937d8bad7c Slightly improved the grammar and clarity of a sentence. (#11679) пре 8 часа
img a82ed18d3d Add FoldableContainer to the Control node gallery page пре 6 месеци
tutorials 931e91d0cd Grammar: change singular possessive to plural possessive пре 10 часа
.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 965685e247 Add more Python-related files to gitignore пре 1 година
.lycheeignore bf27bf2c96 Fix URL check errors пре 10 месеци
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years пре 1 година
.pre-commit-config.yaml 0855668721 Migrate contributing contents to a separate documentation site. пре 4 месеци
.readthedocs.yml d9e0d8386e Add tools definition for RTD пре 2 година
404.rst bcc47750df Fix redirects in pages with other base paths than the default (`/en/stable`). пре 1 недеља
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 пре 7 година
Makefile 31204023b6 Makefile: use sphinx-build -M пре 2 година
README.md f875de93e5 Update contributing links to contributing.godotengine.org. пре 4 месеци
conf.py 7626bd972a Use 4 CPUs on readthedocs by injection. пре 5 дана
index.rst 570a0e8f64 Fix typo in documentation access instructions пре 3 дана
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs пре 2 година
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks пре 1 година
requirements.txt d9b1632465 Bump sphinxcontrib-video from 0.4.1 to 0.4.2 пре 2 недеља
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 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.