readthedocs/sphinx_rtd_theme

Customization options for bitbucket, gitlab, and github are undocumented

Open

#465 建立於 2017年9月16日

在 GitHub 查看
 (7 留言) (10 反應) (1 負責人)CSS (3,473 star) (1,413 fork)batch import
Good First IssueNeeded: documentation

描述

I had to search the source-code to learn of the existence of these options for 'edit page' links. These should be documented properly with descriptions of their usages.

貢獻者指南

技術棧
pythoncss
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic Sphinx knowledgereading source code for theme options
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Investigate the source code of the sphinx rtd theme to find the undocumented customization options for bitbucket, gitlab, and github edit page links. Look for relevant configuration variables in Python files or theme configuration. Check existing comments and documentation templates to understand where to add descriptions.