Skip to content

This fork of the Godot Engine documentation repository is purely for educational purposes. It is not intended to be a comprehensive or authoritative source of documentation. Rather, it is a personal space for learning about the documentation structure and content of the Godot Engine.

License

Notifications You must be signed in to change notification settings

eon-s/godot-docs

This branch is 8 commits ahead of, 1405 commits behind godotengine/godot-docs:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c1143e3 · Mar 16, 2024
Feb 6, 2024
Nov 25, 2023
Feb 26, 2024
Mar 15, 2024
Jan 23, 2024
Nov 25, 2023
Mar 6, 2024
Mar 16, 2024
Jan 24, 2024
Mar 13, 2024
Mar 13, 2024
Jun 15, 2023
Mar 16, 2024
Mar 1, 2021
Mar 1, 2021
May 28, 2023
May 18, 2020
May 5, 2023
Sep 13, 2022
Dec 7, 2018
Mar 28, 2023
May 4, 2023
Jan 11, 2024
Feb 4, 2024
Apr 17, 2023
Jan 13, 2024
Apr 21, 2020

Repository files navigation

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 use the mirror of the documentation hosted on DevDocs. To enable offline browsing on DevDocs, you need to:

  • Click the three dots in the top-left corner, choose Preferences.
  • Enable the desired version of the Godot documentation by checking the box next to it in the sidebar.
  • Click the three dots in the top-left corner, choose Offline data.
  • Click the Install link next to the Godot documentation.

You can also download an HTML copy for offline reading (updated every Monday). 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 for offline reading (updated every Monday). 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

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.

About

This fork of the Godot Engine documentation repository is purely for educational purposes. It is not intended to be a comprehensive or authoritative source of documentation. Rather, it is a personal space for learning about the documentation structure and content of the Godot Engine.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • reStructuredText 99.5%
  • CSS 0.2%
  • Python 0.2%
  • JavaScript 0.1%
  • HTML 0.0%
  • GDScript 0.0%