readthedocs/sphinx_rtd_theme

Customization options for bitbucket, gitlab, and github are undocumented

Open

#465 opened on 2017年9月16日

GitHub で見る
 (7 comments) (10 reactions) (1 assignee)CSS (3,473 stars) (1,413 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.