#godot #docs #howto

tetrapod00 eb4ab3a78e Clarify requirements in Compiling for Windows 10 miesięcy temu
.github edfc55963c Bump peter-evans/create-pull-request from 6 to 7 11 miesięcy temu
_extensions 5c4342caa4 Fix keywords for Vector in GDScript syntax highlighting 11 miesięcy temu
_static 57c24d9b46 Fix scrolling outside of content area 1 rok temu
_styleguides 88970e5daa Add German style guide 1 rok temu
_templates bedd304160 Remove Giscus from search page (#8777) 1 rok temu
_tools 799f39d4b6 Fix redirect to new contribution guidelines 1 rok temu
about 261c9de4c5 Fix typo in FAQ 10 miesięcy temu
classes 0cf8e77ea9 classref: Sync with current master branch (621cadc) 10 miesięcy temu
community 5009868942 Update Discord, refer to website for communities 11 miesięcy temu
contributing eb4ab3a78e Clarify requirements in Compiling for Windows 10 miesięcy temu
getting_started 7a13592c9c Link to Exporting projects in Finishing up page of Your first 2D game 10 miesięcy temu
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 11 miesięcy temu
tutorials 68a83880e5 Fix duplicate "glyph_spacing" in bbcode docs 10 miesięcy temu
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 lat temu
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 lat temu
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 lat temu
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 miesięcy temu
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 lat temu
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 miesięcy temu
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 lat temu
Makefile 31204023b6 Makefile: use sphinx-build -M 2 lat temu
README.md 923fbf2bb6 Update ReadMe file with offline doc options 1 rok temu
conf.py dd9448f725 Bump version 11 miesięcy temu
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 1 rok temu
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 lat temu
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages 1 rok temu
robots.txt fd5f6f4909 Appease our great search engine overlords 5 lat temu

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.