Accueil Explorer Aide
Connexion
godotengine
/
godot-docs
miroir de https://github.com/godotengine/godot-docs
Suivre 1
Voter 1
Fork 0
Fichiers

Official EU-hosted mirror of the Godot Engine GitHub documentation repository, provided as backup and for anyone who cannot access GitHub due to US trade restrictions. Please only use the issue tracker if you are restricted from using GitHub.

Branche: master
Branches Tags
godot-docs
ZIP TAR.GZ
Hugo Locurcio 8d9085ae7c Add guidelines on inline comments in GDScript style guide (#9433) il y a 8 heures
.github 2d30a6940c Merge pull request #10583 from mhilbrunner/gh-2404-imagemagick il y a 2 semaines
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` il y a 1 mois
_static 049b42989e Revert "Fix video alignment after dependency update" il y a 1 semaine
_styleguides 88970e5daa Add German style guide il y a 1 an
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. il y a 1 mois
_tools f70686cdbe CI: Integrate `pre-commit` for style checks il y a 3 mois
about 9ffbae745e Improve links to Step by step il y a 6 jours
classes b55955c3ce classref: Sync with current master branch (96cdbbe) il y a 1 jour
community 78d2ddb14c Update screenshots and descriptions in Asset Library docs (#10665) il y a 3 jours
contributing 40a5a09c00 Update compiling_for_windows.rst (#10562) il y a 15 heures
getting_started 6d1d6f1f32 Merge pull request #10663 from tetrapod00/improve-first-script il y a 12 heures
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) il y a 6 mois
tutorials 8d9085ae7c Add guidelines on inline comments in GDScript style guide (#9433) il y a 8 heures
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) il y a 4 ans
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) il y a 4 ans
.gitignore 965685e247 Add more Python-related files to gitignore il y a 2 semaines
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years il y a 6 mois
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook il y a 2 mois
.readthedocs.yml d9e0d8386e Add tools definition for RTD il y a 1 an
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years il y a 6 mois
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license il y a 6 ans
Makefile 31204023b6 Makefile: use sphinx-build -M il y a 1 an
README.md d4b2a69cf6 Fix broken link in README to Contributing section il y a 3 mois
conf.py 68d7191b39 Add Plausible il y a 2 semaines
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute il y a 7 mois
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs il y a 1 an
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks il y a 3 mois
requirements.txt 40fbaac903 Bump sphinxcontrib-video from 0.3.2 to 0.4.0 il y a 1 semaine
robots.txt fd5f6f4909 Appease our great search engine overlords il y a 4 ans

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

To browse the documentation offline, you can download an HTML copy (updated every Monday): stable, latest, 3.6. Extract the ZIP archive then open the top-level index.html in a web browser.

For mobile devices or e-readers, you can also download an ePub copy (updated every Monday): stable, latest, 3.6. Extract the ZIP archive then open the GodotEngine.epub file in an e-book reader application.

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. Building the manual
  6. Translating the documentation

License

With 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.