From 79c24f9df29e27a83f763118df27f624a144100b Mon Sep 17 00:00:00 2001
From: Tilly Woodfield <22456167+tillywoodfield@users.noreply.github.com>
Date: Tue, 12 Nov 2024 16:40:50 +0200
Subject: [PATCH] docs: document theme option for available languages

---
 docs/index.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/index.rst b/docs/index.rst
index 24a2ab2..7781617 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -37,6 +37,9 @@ This theme has multiple options, which can be configured using the :code:`html_t
   html_theme_options = {
     "github_repository": "https://github.com/organisation/repository",
     "header_title_text": "Title",
+    "languages": {
+      "en": "English",
+    },
     "plausible_domain": "example.com"
   }
 
@@ -52,6 +55,13 @@ This should be a link to the Github repository for the documentation site, and i
 
 The site's title to display in the header and navigation.
 
+:code:`languages`
+-----------------
+
+A dictionary of languages which the documentation is available in, used to populate the language switcher component.
+
+For each entry, the keys (:code:`en`) is used to send the user to the correct site, and the value (:code:`English`) is displayed in the language switcher.
+
 :code:`plausible_domain`
 ------------------------