Domů Procházet Nápověda
Přihlásit se
Godot
/
godot-docs
zrcadlo https://github.com/godotengine/godot-docs.git
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki

#godot #docs #howto

Strom: a6dbd57f96
Větve Značky
godot-docs
ZIP TAR.GZ
Joseph K a6dbd57f96 Typo fix před 2 roky
.github 59345d8ac6 Docs CI: Limit concurrent builds před 2 roky
_extensions 7d5fb4e6a2 Various fixups před 2 roky
_static b57807b618 Make it possible to read abbreviations by tapping on mobile před 2 roky
_templates ca94970356 Less intrusive 4.0 update state info (#7100) před 2 roky
_tools 1b0310aa47 Fix typos and make CI a happy Gobot před 2 roky
about 485116d8a3 Character and typo fixes před 2 roky
classes f9340bddb2 classref: Sync with current master branch (543750a) před 2 roky
community d21e992878 Update submitting_to_assetlib.rst (#7339) před 2 roky
contributing 485116d8a3 Character and typo fixes před 2 roky
getting_started 485116d8a3 Character and typo fixes před 2 roky
img 3dfbfbf381 Add links to demo projects where relevant (#6874) před 2 roky
tutorials a6dbd57f96 Typo fix před 2 roky
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) před 4 roky
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) před 4 roky
.gitignore 47bacc95fd Added configuring ide for rider (#7420) před 2 roky
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors před 5 roky
.readthedocs.yml d9e0d8386e Add tools definition for RTD před 2 roky
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources před 2 roky
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license před 6 roky
Makefile 31204023b6 Makefile: use sphinx-build -M před 2 roky
README.md 9d1dd80374 Build ePubs of the documentation for offline reading před 2 roky
conf.py 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) před 2 roky
index.rst 9d1dd80374 Build ePubs of the documentation for offline reading před 2 roky
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs před 2 roky
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting před 2 roky
robots.txt fd5f6f4909 Appease our great search engine overlords před 5 roky

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 use the mirror of the documentation hosted on DevDocs. To enable offline browsing on DevDocs, you need to:

  • Click the three dots in the top-left corner, choose Preferences.
  • Enable the desired version of the Godot documentation by checking the box next to it in the sidebar.
  • Click the three dots in the top-left corner, choose Offline data.
  • Click the Install link next to the Godot documentation.

You can also 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

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