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: 4cfe07b696
Atzari Tagi
godot-docs
ZIP TAR.GZ
BlueStag 4cfe07b696 Fixed "GetNode" inconsistency 4 gadi atpakaļ
.github 74ac839609 Use a separate GitHub Actions workflow to build offline documentation (#4733) 4 gadi atpakaļ
_extensions 0a087e730f Update copyrights to 2021 4 gadi atpakaļ
_static 1b8549bda1 Update `latest` warning for godot 3.x (#4863) 4 gadi atpakaļ
_templates 9becaa5480 Add Open Graph tags for better link preview on social media 4 gadi atpakaļ
_tools 5e3a7c8fd1 Add a tool to move rst files and images 5 gadi atpakaļ
about d891f33382 Fix "example" spelling in Frequently asked questions (#4862) 4 gadi atpakaļ
classes d0eb1eb6bc Move remaining files out of step_by_step/ 4 gadi atpakaļ
community 5ef81d2ba9 Add a mention of the PR review process and proposals to the contribution guide (#4801) 4 gadi atpakaļ
development 673aa368cc Bump required Mono version to 6.12 4 gadi atpakaļ
getting_started b7e9a081fd add C# code tabs to pages under first_3d_game 4 gadi atpakaļ
img c499c65682 Add image for Node2D's get_angle_to_point(point) (#4703) 4 gadi atpakaļ
tutorials 4cfe07b696 Fixed "GetNode" inconsistency 4 gadi 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 1361ffb70c Add _tools folder for utility scripts 5 gadi atpakaļ
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 gadi atpakaļ
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 gadi atpakaļ
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 gadi atpakaļ
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 gadi atpakaļ
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 gadi atpakaļ
README.md 74ac839609 Use a separate GitHub Actions workflow to build offline documentation (#4733) 4 gadi atpakaļ
conf.py 0a087e730f Update copyrights to 2021 4 gadi atpakaļ
index.rst 74ac839609 Use a separate GitHub Actions workflow to build offline documentation (#4733) 4 gadi atpakaļ
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 gadi atpakaļ
requirements.txt 9940fc39b3 Bump sphinx-rtd-theme from 0.5.1 to 0.5.2 4 gadi 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

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.

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