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.
Customization options for bitbucket, gitlab, and github are undocumented · readthedocs/sphinx_rtd_theme#465 | Good First Issue