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

Koks: 2647373fc2
Atzari Tagi
godot-docs
ZIP TAR.GZ
Jacob Ibáñez Sánchez 2647373fc2 Remove unnecessary opinion about languages. 1 gadu atpakaļ
.github 78189da9d8 Bump peter-evans/create-pull-request from 5 to 6 1 gadu atpakaļ
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 gadu atpakaļ
_static 2526852231 Use Montserrat font for headings to match godotengine.org 1 gadu atpakaļ
_styleguides 88970e5daa Add German style guide 1 gadu atpakaļ
_templates 0a01baec10 Fix epub-related failures (#8207) 1 gadu atpakaļ
_tools f382d171cc Add `thirdparty` as linter exception 1 gadu atpakaļ
about e74e3e354a Document how to handle compatibility breakages 1 gadu atpakaļ
classes e43e650135 classref: Sync with current 4.2 branch (7a3a36a) 1 gadu atpakaļ
community 7f8c3ce7b7 Update the community channels 1 gadu atpakaļ
contributing e74e3e354a Document how to handle compatibility breakages 1 gadu atpakaļ
getting_started e4851622df pi/4 is 45 degrees. 1 gadu atpakaļ
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 gadi atpakaļ
tutorials 2647373fc2 Remove unnecessary opinion about languages. 1 gadu 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 47bacc95fd Added configuring ide for rider (#7420) 2 gadi atpakaļ
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 gadi atpakaļ
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 gadi atpakaļ
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 gadi atpakaļ
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 gadi atpakaļ
Makefile 31204023b6 Makefile: use sphinx-build -M 2 gadi atpakaļ
README.md f9947573e9 Merge branch 'DevDocsReadMe' of https://github.com/skyace65/godot-docs into DevDocsReadMe 1 gadu atpakaļ
conf.py 4b68d56c63 Add table of contents to epub of docs 1 gadu atpakaļ
index.rst 0f7eaa9dae Added separate links to stable/latest/3.6 copies of the offline documentation 1 gadu atpakaļ
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 gadi atpakaļ
requirements.txt 1db6e49e0f Pin sphinx-contrib libraries to pre-5.0 version 1 gadu 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 for offline reading (updated every Monday). 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 for offline reading (updated every Monday). 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.