#godot #docs #howto

Aditya K Kamath f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. 6 mesi fa
.github d3a902e2d8 Add GitHub Action to automatically create cherrypick PRs (#10361) 6 mesi fa
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` 7 mesi fa
_static 0da4dbe145 Add self links to shader functions page 7 mesi fa
_styleguides 88970e5daa Add German style guide 1 anno fa
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. 6 mesi fa
_tools f70686cdbe CI: Integrate `pre-commit` for style checks 8 mesi fa
about c4d3aa134a Standardize RST header syntax 6 mesi fa
classes eab235f772 classref: Sync with current master branch (bdf625b) 6 mesi fa
community e7cea212a4 Merge pull request #10459 from tetrapod00/typo-tutorials 6 mesi fa
contributing f1d751b4a9 Mention Vulkan and Direct3D 12 SDK install scripts in Compiling for macOS/Windows 6 mesi fa
getting_started 4f70dc1ebd Mention the expected file name for the player scene in Your first 2D game 6 mesi fa
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 11 mesi fa
tutorials 7d38ce8fef upload images and edit pages 6 mesi fa
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 anni fa
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 anni fa
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 anni fa
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 mesi fa
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 8 mesi fa
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 anni fa
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 mesi fa
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 anni fa
Makefile 31204023b6 Makefile: use sphinx-build -M 2 anni fa
README.md d4b2a69cf6 Fix broken link in README to Contributing section 9 mesi fa
conf.py 2cbe8488d4 Update broken link to RTD docs in comment 7 mesi fa
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 1 anno fa
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 anni fa
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 8 mesi fa
requirements.txt e5d8855e36 Bump pygments from 2.18.0 to 2.19.0 6 mesi fa
robots.txt fd5f6f4909 Appease our great search engine overlords 5 anni fa

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.