Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 3.37 KB

README.md

File metadata and controls

63 lines (44 loc) · 3.37 KB
Raw

Redot Engine documentation

This repository contains the source files of Redot 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 Redot's website.

Download for offline use

To browse the documentation offline, you can download an HTML copy (updated every Monday): stable, latest. 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. Extract the ZIP archive then open the RedotEngine.epub file in an e-book reader application.

Migrating

We are transitioning from Godot to Redot. In this period, a temporary solution is available.

python migrate.py . _migrated True

After the docs are converted, you can build with

sphinx-build -b html ./_migrated/ _build/html

Theming

The Redot 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 Redot 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 "the Redot community, modified from an original work by Juan Linietsky, Ariel Manzur and the Godot community". See LICENSE.txt for details.

The files in the classes/ folder are derived from Redot's main source repository and are distributed under the MIT license, with the same authors as above.