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: b4a57eeaa8
Branches Tags
godot-docs
ZIP TAR.GZ
Nathan Lovato b4a57eeaa8 Merge pull request #4472 from psobolik/animation-intro-tweaks 4 years ago
.github b1b0ca4e4c Check for updates to GitHub Actions every weekday 4 years ago
_extensions 7b60dd1794 Escape double quotes for meta descriptions in HTML 5 years ago
_static cbeb9212cc Fix the "ref" badge appearing twice in search results 4 years ago
_templates d494d19dac Remove trailing whitespace and irregular whitespace 5 years ago
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 years ago
about d0eb1eb6bc Move remaining files out of step_by_step/ 4 years ago
classes d0eb1eb6bc Move remaining files out of step_by_step/ 4 years ago
community f48ef2d539 Mention BornCG's 2D tutorials in Tutorials and resources (#4444) 4 years ago
development 9cd09cc2d0 Merge pull request #4067 from NathanLovato/content/writing-guidelines-updates 4 years ago
getting_started a9a0e99fef Fix Hide() in _ready() first player example code 4 years ago
img d585cf540e Add a preview image of Color constants by @theowiik 5 years ago
tutorials bf5ee98c6d Edit animation intro page 4 years ago
.gitattributes 34f97a7544 GitHub linguist: Mark .rst files as detectable 5 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 bdeb07691a Fix URL typo in the README (#4415) 4 years ago
conf.py bdece44b8d Prevent the compatibility notice from being the `meta description` 5 years ago
index.rst e32454978c Write the first three parts of the 3D tutorial 4 years ago
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 years ago
requirements.txt 45d95db39f Update instant search plugin to a packaged version (#3963) 5 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.

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.