Version markers¶
A version marker records when something was added, changed, deprecated or removed,
with the label a Sphinx build gives it (Added in version 1.4).
Each takes the version as its first argument;
any text after the version — on the same line, or on the indented lines straight below it with no blank line —
becomes the marker’s first paragraph,
and a body adds more.
ubCode renders all eight spellings in the editor preview and in its html and pdf builds.
Added, changed, deprecated and removed¶
The four markers are versionadded, versionchanged, deprecated and versionremoved.
Version markers
.. versionadded:: 1.4
Collapsible boxes.
.. versionchanged:: 1.5
Boxes can start folded.
.. deprecated:: 2.0
Use a dropdown instead.
.. versionremoved:: 3.0
Collapsible boxes are gone.
Added in version 1.4: Collapsible boxes.
Changed in version 1.5: Boxes can start folded.
Deprecated since version 2.0: Use a dropdown instead.
Removed in version 3.0: Collapsible boxes are gone.
```{versionadded} 1.4 Collapsible boxes.
```
```{versionchanged} 1.5 Boxes can start folded.
```
```{deprecated} 2.0 Use a dropdown instead.
```
```{versionremoved} 3.0
Collapsible boxes are gone.
```
The MyST form renders live in the MyST version markers.
In MyST the text after the version sits on the fence’s first line, which, on a backtick fence, cannot contain a backtick (the line would stop being a fence); put text with inline code in the body instead.
The hyphenated spellings¶
version-added, version-changed, version-deprecated and version-removed
are the same four markers under the names Sphinx 9 added,
and render identically, down to the CSS class
(see the version-marker differences).
Hyphenated version markers
.. version-added:: 1.4
.. version-changed:: 1.5
.. version-deprecated:: 2.0
.. version-removed:: 3.0
Added in version 1.4.
Changed in version 1.5.
Deprecated since version 2.0.
Removed in version 3.0.
```{version-added} 1.4
```
```{version-changed} 1.5
```
```{version-deprecated} 2.0
```
```{version-removed} 3.0
```
The MyST form renders live in the MyST hyphenated spellings.