2
0

#godot #docs #howto

Rémi Verschelde 7470103edc Merge pull request #5394 from akien-mga/classref-docs-url 3 жил өмнө
.github 7b35584569 GitHub Actions: Don't build with warnings-as-errors for offline doc 3 жил өмнө
_extensions 45c9248c06 Update GDScriptLexer to GDScript 2.0 4 жил өмнө
_static 4f67dc3cac Reorganize and update the "BBCode in RichTextLabel" article 4 жил өмнө
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 жил өмнө
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 жил өмнө
about fa34841739 Improve the FreeType copyright year editor mention 3 жил өмнө
classes b0fb19f75c classref: Sync with godotengine/godot#54991 to dehardcode docs URL 3 жил өмнө
community 154c093f97 C++ style guide: Require clang-format 13 3 жил өмнө
development cb5f51a2e7 Add libatomic-static dependency for Fedora in Compiling for Linux, *BSD 3 жил өмнө
getting_started 047ba3909f Type for loop invariant, i/index, in squash check 3 жил өмнө
img aff48371b2 Add cheatsheet and comparison image for `ease()` and `smoothstep()` 4 жил өмнө
tutorials 22f17d24fc Fix missing word in When and how to avoid using nodes for everything (#5386) 3 жил өмнө
.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 1361ffb70c Add _tools folder for utility scripts 5 жил өмнө
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 жил өмнө
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 жил өмнө
AUTHORS.md c7144215ef Fix formatting on AUTHORS.md file 3 жил өмнө
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 жил өмнө
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 жил өмнө
README.md 4060179184 Remove trailing space characters (#5251) 4 жил өмнө
conf.py 4060179184 Remove trailing space characters (#5251) 4 жил өмнө
index.rst 4664df9819 Build offline documentation for the stable branch as well (#4896) 4 жил өмнө
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 жил өмнө
requirements.txt 308f6e4f54 Pin docutils to <0.18 to fix CI due to new warning 3 жил өмнө
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

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.