readthedocs/sphinx_rtd_theme

Global setting for disabling "Edit button"

Open

#1,366 建立於 2022年11月1日

在 GitHub 查看
 (0 留言) (1 反應) (0 負責人)CSS (3,473 star) (1,413 fork)batch import
FeatureGood First IssueImprovement

描述

People are having issues figuring out how to remove the "Edit on Github" button, and I would agree that it's cumbersome.

I don't think it's a good idea to remove it, but I'm sure people have their reasons.

The most straight-forward solution would probably be to respect the html_show_sourcelink setting.

See also: https://github.com/sphinx-doc/sphinx/issues/2386

貢獻者指南

技術棧
pythoncsshtml
領域
documentationfrontend
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Familiarity with Sphinx theme configurationUnderstanding of Sphinx templating
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65
研究方向
Investigate the theme's template files, likely `layout.html` or similar, to locate where the 'Edit on GitHub' button is rendered. Then look at how other settings like `html show sourcelink` are implemented in Sphinx's core and the theme to add a similar global toggle. The linked issue #2386 provides additional context on the setting's behavior.