#godot #docs #howto

Nathan Lovato d74261bfb5 Move docs contribution guides from the README to Contributing 4 yıl önce
.github b1b0ca4e4c Check for updates to GitHub Actions every weekday 4 yıl önce
_extensions 7b60dd1794 Escape double quotes for meta descriptions in HTML 4 yıl önce
_static cbeb9212cc Fix the "ref" badge appearing twice in search results 4 yıl önce
_templates d494d19dac Remove trailing whitespace and irregular whitespace 5 yıl önce
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 yıl önce
about be025d958f Update GDScript FAQ text to not reference history in link (#4357) 4 yıl önce
classes 4741f8dba2 Move assets section to a new assets pipeline section 4 yıl önce
community d74261bfb5 Move docs contribution guides from the README to Contributing 4 yıl önce
development fe208d1425 Fix "initialize" typo in Code::Blocks configuration page (#4243) 4 yıl önce
getting_started 9df8c5c383 Edit content guidelines, remove typographic marks 4 yıl önce
img d585cf540e Add a preview image of Color constants by @theowiik 4 yıl önce
tutorials 9df8c5c383 Edit content guidelines, remove typographic marks 4 yıl önce
.gitattributes 34f97a7544 GitHub linguist: Mark .rst files as detectable 5 yıl önce
.gitignore 1361ffb70c Add _tools folder for utility scripts 5 yıl önce
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 yıl önce
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 yıl önce
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 yıl önce
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 yıl önce
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 yıl önce
README.md d74261bfb5 Move docs contribution guides from the README to Contributing 4 yıl önce
conf.py bdece44b8d Prevent the compatibility notice from being the `meta description` 4 yıl önce
index.rst 4741f8dba2 Move assets section to a new assets pipeline section 4 yıl önce
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 yıl önce
requirements.txt 45d95db39f Update instant search plugin to a packaged version (#3963) 4 yıl önce
robots.txt fd5f6f4909 Appease our great search engine overlords 5 yıl önce

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. Writing guidelines
  4. 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.