Rémi Verschelde
a29b557361
It will look up a potential `classes/<lang>` folder in the parent repository of https://github.com/godotengine/godot-docs-l10n and use it if provided. This folder includes a pre-translated copy of the class reference XML, read to be used by Sphinx. This turned out to be a simpler approach than generating PO files for class reference strings in reStructured Text format, given that their source format is XML and the conversion on a per `msgid` basis would be quite tricky. This approach is very hacky, as Sphinx doesn't seem to support any kind of conditional statements in its `toctree` directives, so we have to outright replace the content at build time. This should typically only be done on RTD so it shouldn't end up polluting the Git history.
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
You can 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.
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:
- Contributing to the online manual
- Contributing to the class reference
- Content guidelines
- Writing guidelines
- 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.