Skip to content

[Doc]: add sphinx versioning directives #23506

@story645

Description

@story645

Documentation Link

No response

Problem

It can be unclear which features were added when just by looking at the docs, and would be helpful if at at least major features (and whatever else folks think would be a good idea) could be flagged with a version added/changed/etc directive.

Suggested improvement

Introduce the versioning directives

Per the call (link), a first step is to create a pr with some sample directives:

Additionally sort out guidance for adding directive (to which prs) and update PR guidelines accordingly :

As a first pass, my guess is anything that gets a what's new should get a version added, anything that gets an api change should get a versionchanged, and deprecated is already added as part of the decorator

f".. deprecated:: {since}\n"

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions