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

Jump to bottom

In sidebar, add links to the reST sources (aka html_show_sourcelink). #32

Closed
return42 opened this issue Aug 7, 2020 · 1 comment
Closed

In sidebar, add links to the reST sources (aka html_show_sourcelink). #32

return42 opened this issue Aug 7, 2020 · 1 comment

Comments

@return42
Copy link

return42 commented Aug 7, 2020

This is not really a issue, its more a question ...

I guess html_show_sourcelink is not supported by pallets-sphinx-themes .. right?

If so and since the default of html_show_sourcelink is True, is it better to set

 html_show_sourcelink = False

to not copy sources into the dist folder _sources?

What should a PR add, changing the default to False or is it better to implement the function right away?
@davidism
Copy link
Member

Add "sourelink.html" to the html_sidebars config. It's part of Sphinx's basic theme and not overridden by this theme.

return42 added a commit to return42/searxng that referenced this issue Nov 17, 2021
@return42
[mod] doc - in sidebar, add links to the reST sources
7886b98 
Offer links to the reST sources (aka) html_show_sourcelink [1].  Links to the
reST source are sometimes very helpful, especially in our resT-Primer [2] :)

[1] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_show_sourcelink
[2] https://searxng.github.io/searxng/dev/reST.html

Related-to: pallets/pallets-sphinx-themes#32
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
return42 added a commit to return42/searxng that referenced this issue Nov 18, 2021
@return42
[mod] doc - in sidebar, add links to the reST sources
2cc2406 
Offer links to the reST sources (aka) html_show_sourcelink [1].  Links to the
reST source are sometimes very helpful, especially in our resT-Primer [2] :)

[1] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_show_sourcelink
[2] https://searxng.github.io/searxng/dev/reST.html

Related-to: pallets/pallets-sphinx-themes#32
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 9, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@return42 @davidism