Skip to content

Commit a113600

Browse files
committed
docs/customisation/edit-button: explain that html_show_sourcelink is ignored
1 parent 0535011 commit a113600

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

docs/conf.py

+10
Original file line numberDiff line numberDiff line change
@@ -147,3 +147,13 @@
147147
"class": "fa-brands fa-solid fa-github fa-2x",
148148
},
149149
]
150+
151+
152+
def setup(app):
153+
# See https://github.com/sphinx-doc/sphinx/issues/5562#issuecomment-434296574
154+
app.add_object_type(
155+
"confval",
156+
"confval",
157+
objname="configuration value",
158+
indextemplate="pair: %s; configuration value",
159+
)

docs/customisation/edit-button.md

+5
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,8 @@ If you're building documentation on Read the Docs using a github.com-hosted repo
4545
If you wish to disable this, use {ref}`top_of_page_button` and set it to `None`.
4646

4747
[sphinx-html_theme_options]: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme_options
48+
49+
## Source link
50+
51+
Sphinx configuration option {confval}`sphinx:html_show_sourcelink` is ignored by this theme.
52+
The only supported link to the sources is through the edit button.

0 commit comments

Comments
 (0)