mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-11-02 20:30:30 -06:00
Add a `versionremoved` directive (#11905)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
11 files changed
+43
-8
No files matched your search
@@ -323,6 +323,18 @@ units as well as normal text.
|
||||
.. deprecated:: 3.1
|
||||
Use :func:`spam` instead.
|
||||
|
||||
.. rst:directive:: .. versionremoved:: version
|
||||
|
||||
Similar to :rst:dir:`versionadded`, but describes when the feature was removed.
|
||||
An explanation may be provided to inform the reader what to use instead,
|
||||
or why the feature was removed.
|
||||
Example::
|
||||
|
||||
.. versionremoved:: 4.0
|
||||
The :func:`spam` function is more flexible, and should be used instead.
|
||||
|
||||
.. versionadded:: 7.3
|
||||
|
||||
.. rst:directive:: seealso
|
||||
|
||||
Many sections include a list of references to module documentation or
|
||||
|
||||
Reference in new issue
Block a user