95fb178429
This allows users to leave comments on pages that don't have `:allow_comments: False` somewhere in the page's source. Both manual and class reference pages can receive comments. Index pages cannot have comments, as discussion should occur on "leaf" pages. GitHub Discussions is used as a backend on the same repository. This means that Discussions *must* be enabled on godotengine/godot-docs before this commit is merged to `master`. Users can choose to use the "Custom" watch mode if they don't want to get notifications for discussion updates, but still get notifications for issue and pull request updates. User comments are intended to be used for the following purposes: - Add a clarification or correct something in the documentation, without having to open a pull request. Contributors are encouraged to take a look at discussions from time to time, and see if there's information worth incorporating in the pages themselves. Don't forget to reply to the comment when doing so :) - Mention a workaround for a common issue. - Link to useful third-party resources that are relevant to the current page, such as tutorials or add-ons. User comments should *not* be used for technical support. Other community platforms should be used for that. Page-to-discussion matching is done using the `pagename` Sphinx variable, which is independent of the Godot version and documentation language. Being independent of the Godot version allows keeping old comments when the Godot version changes, while also allowing users from `/stable` and `/4.1` to "see" each other in discussions. See https://giscus.app for more information.
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:
- Contributing to the online manual
- Contributing to the class reference
- Content guidelines
- Writing guidelines
- Building the manual
- 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.