Home Verkennen Help
Inloggen
Godot
/
godot-docs
spiegel van https://github.com/godotengine/godot-docs.git
2
0
Vork 0
Bestanden Issues 0 Wiki

#godot #docs #howto

Boom: cf655aa176
Aftakkingen Labels
godot-docs
ZIP TAR.GZ
Hugo Locurcio cf655aa176 Revert "Fix Sphinx `add_lexer()` deprecation in the GDScript extension (#4594)" 4 jaren geleden
.github aab75310c7 Update PR template 4 jaren geleden
_extensions cf655aa176 Revert "Fix Sphinx `add_lexer()` deprecation in the GDScript extension (#4594)" 4 jaren geleden
_static cbeb9212cc Fix the "ref" badge appearing twice in search results 4 jaren geleden
_templates d494d19dac Remove trailing whitespace and irregular whitespace 5 jaren geleden
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 jaren geleden
about 1ec802463a Add MP3 to the list of supported audio formats (#4569) 4 jaren geleden
classes d0eb1eb6bc Move remaining files out of step_by_step/ 4 jaren geleden
community de34df3ecb Add @TheGuideKnight's 2D tutorial series to Tutorials and resources (#4592) 4 jaren geleden
development 1a36804d99 Merge pull request #4541 from Calinou/add-editor-development-page 4 jaren geleden
getting_started 1cdd6c9cc7 Replace instance diagram images for readability on all backgrounds (#4609) 4 jaren geleden
img e1e08419f6 Add a page referencing the Control gallery image and demo 4 jaren geleden
tutorials 3f3e203bdd Fix CSharp instanciation example (#4618) 4 jaren geleden
.gitattributes 34f97a7544 GitHub linguist: Mark .rst files as detectable 5 jaren geleden
.gitignore 1361ffb70c Add _tools folder for utility scripts 5 jaren geleden
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 jaren geleden
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 jaren geleden
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 jaren geleden
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 jaren geleden
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 jaren geleden
README.md bdeb07691a Fix URL typo in the README (#4415) 4 jaren geleden
conf.py f528a844d6 Add a more descriptive custom 404 error page (#4624) 4 jaren geleden
index.rst 511d28134e Link to DevDocs on the home page for offline browsing 4 jaren geleden
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 jaren geleden
requirements.txt f528a844d6 Add a more descriptive custom 404 error page (#4624) 4 jaren geleden
robots.txt fd5f6f4909 Appease our great search engine overlords 5 jaren geleden

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.