Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki

#godot #docs #howto

Tree: 082d50eb68
Branches Tags
godot-docs
ZIP TAR.GZ
Rémi Verschelde 082d50eb68 Merge pull request #4924 from Calinou/faq-feature-set-fix-typo 4 years ago
.github 74ac839609 Use a separate GitHub Actions workflow to build offline documentation (#4733) 4 years ago
_extensions 0a087e730f Update copyrights to 2021 4 years ago
_static 1b8549bda1 Update `latest` warning for godot 3.x (#4863) 4 years ago
_templates 9becaa5480 Add Open Graph tags for better link preview on social media 4 years ago
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 years ago
about 0dd27e223e Fix typo in FAQ about Godot's feature set: "advance" -> "advantage" 4 years ago
classes d0eb1eb6bc Move remaining files out of step_by_step/ 4 years ago
community 300423f0b8 Specify that you need to call `--doctool` from the Godot root directory (#4920) 4 years ago
development 8c4bd39379 Remove obsolete `CXXFLAGS` override in Custom modules in C++ 4 years ago
getting_started 99a44fac6b Mention the new main screen switch shortcuts (#4903) 4 years ago
img 4ed76436c8 Add an image for Camera3D is_position_behind and is_position_in_frustum (#4883) 4 years ago
tutorials 871422f576 Remove reference to 3.0 from 2D lights and shows 4 years ago
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 years ago
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 years ago
.gitignore 1361ffb70c Add _tools folder for utility scripts 5 years ago
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 years ago
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 years ago
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 years ago
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 years ago
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 years ago
README.md 74ac839609 Use a separate GitHub Actions workflow to build offline documentation (#4733) 4 years ago
conf.py 0a087e730f Update copyrights to 2021 4 years ago
index.rst 74ac839609 Use a separate GitHub Actions workflow to build offline documentation (#4733) 4 years ago
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 years ago
requirements.txt 9940fc39b3 Bump sphinx-rtd-theme from 0.5.1 to 0.5.2 4 years ago
robots.txt fd5f6f4909 Appease our great search engine overlords 5 years ago

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.