docs/customisation/edit-button: explain that html_show_sourcelink is …

…ignored
pradyunsg · Mar 26, 2023 · a113600 · a113600
1 parent 0535011
commit a113600
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -147,3 +147,13 @@
             "class": "fa-brands 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
@@ -45,3 +45,8 @@ If you're building documentation on Read the Docs using a github.com-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.