Sākums Izpētīt Palīdzība
Pierakstīties
Godot
/
godot-docs
spogulis no https://github.com/godotengine/godot-docs.git
2
0
Atdalīts 0
Faili Problēmas 0 Vikivietne

#godot #docs #howto

Atzars: master
Atzari Tagi
godot-docs
ZIP TAR.GZ
Max Hilbrunner 094f10f0f3 Merge pull request #11524 from godotengine/dependabot/github_actions/peter-evans/create-pull-request-8 2 dienas atpakaļ
.github 1478c1431d Bump peter-evans/create-pull-request from 7 to 8 3 dienas atpakaļ
_extensions ae44232a70 Revert "read classes from file when lexing" 1 mēnesi atpakaļ
_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 mēneši atpakaļ
_styleguides 0855668721 Migrate contributing contents to a separate documentation site. 3 mēneši atpakaļ
_templates 0855668721 Migrate contributing contents to a separate documentation site. 3 mēneši atpakaļ
_tools e69b689540 Add JavaScript-based redirects to supplement Read the Docs redirects 2 mēneši atpakaļ
about 5c87c639ff Update FAQ section on using Godot's UI toolkit as a library 2 dienas atpakaļ
classes 6da2fd7af3 classref: Sync with current master branch (235a32a) 3 nedēļas atpakaļ
community e5bd72825a Replace Harvard course recommendation with Learn GDScript from Zero 1 mēnesi atpakaļ
engine_details 729a089dd1 Merge pull request #11521 from AdriaandeJongh/custom-macos-export-templates 2 dienas atpakaļ
getting_started abe420bdd6 Add macOS shortcut for running the scene (#11277) 2 nedēļas atpakaļ
img a82ed18d3d Add FoldableContainer to the Control node gallery page 5 mēneši atpakaļ
tutorials 3b4366cdd9 Merge pull request #11507 from Calinou/making-plugins-script-classes 2 dienas atpakaļ
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 gadi atpakaļ
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 gadi atpakaļ
.gitignore 965685e247 Add more Python-related files to gitignore 10 mēneši atpakaļ
.lycheeignore bf27bf2c96 Fix URL check errors 8 mēneši atpakaļ
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 gadu atpakaļ
.pre-commit-config.yaml 0855668721 Migrate contributing contents to a separate documentation site. 3 mēneši atpakaļ
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 gadi atpakaļ
404.rst 77a966c622 Fetch redirects based on the current URL. (#11450) 3 nedēļas atpakaļ
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 gadu atpakaļ
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 7 gadi atpakaļ
Makefile 31204023b6 Makefile: use sphinx-build -M 2 gadi atpakaļ
README.md f875de93e5 Update contributing links to contributing.godotengine.org. 3 mēneši atpakaļ
conf.py 3cc1b0d979 Bump version 3 mēneši atpakaļ
index.rst 0855668721 Migrate contributing contents to a separate documentation site. 3 mēneši atpakaļ
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 gadi atpakaļ
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 1 gadu atpakaļ
requirements.txt 01970e58b2 Bump sphinxext-opengraph from 0.12.0 to 0.13.0 3 mēneši atpakaļ
robots.txt fd5f6f4909 Appease our great search engine overlords 5 gadi atpakaļ

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.