#godot #docs #howto

Nathan Lovato 9cd09cc2d0 Merge pull request #4067 from NathanLovato/content/writing-guidelines-updates 4 年之前
.github b1b0ca4e4c Check for updates to GitHub Actions every weekday 5 年之前
_extensions 7b60dd1794 Escape double quotes for meta descriptions in HTML 5 年之前
_static cbeb9212cc Fix the "ref" badge appearing twice in search results 4 年之前
_templates d494d19dac Remove trailing whitespace and irregular whitespace 5 年之前
_tools 5e3a7c8fd1 Add a tool to move rst files and images 5 年之前
about 9cd09cc2d0 Merge pull request #4067 from NathanLovato/content/writing-guidelines-updates 4 年之前
classes 4741f8dba2 Move assets section to a new assets pipeline section 4 年之前
community 9cd09cc2d0 Merge pull request #4067 from NathanLovato/content/writing-guidelines-updates 4 年之前
development 9cd09cc2d0 Merge pull request #4067 from NathanLovato/content/writing-guidelines-updates 4 年之前
getting_started 471618db61 Clarify that GDScript is not based on Python 4 年之前
img d585cf540e Add a preview image of Color constants by @theowiik 5 年之前
tutorials 9cd09cc2d0 Merge pull request #4067 from NathanLovato/content/writing-guidelines-updates 4 年之前
.gitattributes 34f97a7544 GitHub linguist: Mark .rst files as detectable 5 年之前
.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 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 年之前
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 87a87205fb Rewrite contributing/index, rename pages, update references 4 年之前
conf.py bdece44b8d Prevent the compatibility notice from being the `meta description` 5 年之前
index.rst 4741f8dba2 Move assets section to a new assets pipeline section 4 年之前
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 年之前
requirements.txt 45d95db39f Update instant search plugin to a packaged version (#3963) 5 年之前
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.

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.