From 424f81ca85bf86ec061213e20a64a47ad2858136 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Thu, 6 Aug 2020 18:54:18 +0200 Subject: [PATCH] Document theming customizations in the README This is a relatively important caveat in the documentation, so it's worth mentioning in the README. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index b4a63268b..9f8471295 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,17 @@ This repository contains the source files of [Godot Engine](https://godotengine. They are meant to be parsed with the [Sphinx](https://www.sphinx-doc.org/) documentation builder to build the HTML documentation on [Godot's website](https://docs.godotengine.org). +## Theming + +The Godot documentation uses the default ``sphinx_rtd_theme`` with many +[customizations](_static/) 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](https://addons.mozilla.org/en-US/firefox/addon/dark-mode-website-switcher/) +add-on. + ## Contributing changes **Pull Requests should use the `master` branch by default. Only make Pull Requests against other branches (e.g. `2.1` or `3.0`) if your changes only apply to that specific version of Godot.**