From 92ca19e450d5f051c4a34856c5a77e563a97cc35 Mon Sep 17 00:00:00 2001
From: Unai Martinez-Corral <unai.martinezcorral@ehu.eus>
Date: Thu, 2 Mar 2023 01:55:29 +0100
Subject: [PATCH] docs/customisation/edit-button: explain that
 html_show_sourcelink is ignored

---
 docs/conf.py                      | 10 ++++++++++
 docs/customisation/edit-button.md |  5 +++++
 2 files changed, 15 insertions(+)

diff --git a/docs/conf.py b/docs/conf.py
index 125352c4f..9b6b9590c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -148,3 +148,13 @@
             "class": "fa-solid fa-github fa-2x",
         },
     ]
+
+
+def setup(app):
+    # See https://github.com/sphinx-doc/sphinx/issues/5562#issuecomment-434296574
+    app.add_object_type(
+        "confval",
+        "confval",
+        objname="configuration value",
+        indextemplate="pair: %s; configuration value",
+    )
diff --git a/docs/customisation/edit-button.md b/docs/customisation/edit-button.md
index dc7749a42..25d881e10 100644
--- a/docs/customisation/edit-button.md
+++ b/docs/customisation/edit-button.md
@@ -45,3 +45,8 @@ If you're building documentation on Read the Docs using a jackfan.us.kg-hosted repo
 If you wish to disable this, use {ref}`top_of_page_button` and set it to `None`.
 
 [sphinx-html_theme_options]: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme_options
+
+## Source link
+
+Sphinx configuration option {confval}`sphinx:html_show_sourcelink` is ignored by this theme.
+The only supported link to the sources is through the edit button.