IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add a `versionremoved` directive (#11905)

Browse Source 
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:
Hugo van Kemenade
2024-01-21 22:12:52 +02:00
committed by GitHub
parent 2418e007ce
commit 95b2cce9a0
11 changed files with 43 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/usage/builders/index.rst
View File

@@ -453,9 +453,9 @@ name is ``rinoh``. Refer to the `rinohtype manual`_ for details.
.. class:: ChangesBuilder
This builder produces an HTML overview of all :rst:dir:`versionadded`,
:rst:dir:`versionchanged` and :rst:dir:`deprecated` directives for the
current :confval:`version`. This is useful to generate a ChangeLog file, for
example.
:rst:dir:`versionchanged`, :rst:dir:`deprecated` and :rst:dir:`versionremoved`
directives for the current :confval:`version`. This is useful to generate a
changelog file, for example.
.. autoattribute:: name

12
doc/usage/restructuredtext/directives.rst
View File

@@ -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