sphinx-doc/sphinx

Support multiple versions in the changeset domain

Open

#11,694 opened on Sep 22, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Python (1,985 forks)batch import
domainhelp wanted

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 merged PRs in 30d)

Description

See https://github.com/python/cpython/issues/101716 for rationale.

We could do this probably via a directive option to explicitly specifiy the versions targeted.

A

Contributor guide

Research direction
Investigate the changeset domain in Sphinx and implement a directive option to specify multiple versions as per the rationale in the linked CPython issue.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30