readthedocs/sphinx_rtd_theme

Customization options for bitbucket, gitlab, and github are undocumented

Open

#465 opened on Sep 16, 2017

View on GitHub
 (7 comments) (10 reactions) (1 assignee)CSS (3,473 stars) (1,413 forks)batch import
Good First IssueNeeded: documentation

Description

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.

Contributor guide

Tech stack
pythoncss
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Sphinx knowledgereading source code for theme options
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.