docs/customisation/edit-button: explain that html_show_sourcelink is ignored #631
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
umarcor
force-pushed
the
umarcor/sourcelink
branch
from
eff1402
to
92ca19e
Compare
umarcor
force-pushed
the
umarcor/sourcelink
branch
from
92ca19e
to
a113600
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As explained in #374, html_show_sourcelink is ignored since a year ago. However, it took be a while to find that. Particularly, searching the docs did not provide any result.
This PR adds an explanation to the docs, so that users searching
html_show_sourcelinkwill get some result and can be aware of it.In order to link to the sphinx docs through intersphinx, I had to add a custom object type. See sphinx-doc/sphinx#5562 (comment).