Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/customisation/edit-button: explain that html_show_sourcelink is ignored #631

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs/customisation/edit-button: explain that html_show_sourcelink is ignored #631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs/customisation/edit-button: explain that html_show_sourcelink is … 
…ignored
  • Loading branch information
@umarcor
umarcor committed Mar 26, 2023
commit a113600f5f99880a85643646e0dd88bc5248a525
10 changes: 10 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
)
5 changes: 5 additions & 0 deletions docs/customisation/edit-button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.