Version changes

Sphinx has support for a group of special directives to help describe changes between versions:

  • versionadded

  • versionchanged

  • deprecated

  • versionremoved

To read about them, follow this link to the Sphinx documentation.

Examples

Without text

Examples of versionadded, versionchanged, deprecated and versionremoved getting only the version parameter.

:::{versionadded} 5.15
:::

Added in version 5.15.

.. versionadded:: 5.15

Added in version 5.15.

:::{versionchanged} 5.15
:::

Changed in version 5.15.

.. versionchanged:: 5.15

Changed in version 5.15.

:::{deprecated} 5.15
:::

Deprecated since version 5.15.

.. deprecated:: 5.15

Deprecated since version 5.15.

:::{versionremoved} 5.15
:::

Removed in version 5.15.

.. versionremoved:: 5.15

Removed in version 5.15.

With text

Examples of versionadded, versionchanged, deprecated and versionremoved getting the version parameter and an explanatory text.

:::{versionadded} 7.0
The date/time types datetime and timespan have been superseded by
the SQL92-defined types timestamp and interval. Although there has
been some effort to ease the transition by allowing PostgreSQL to
recognize the deprecated type names and translate them to the new
type names, this mechanism cannot be completely transparent to your
existing application.
:::

Added in version 7.0: The date/time types datetime and timespan have been superseded by the SQL92-defined types timestamp and interval. Although there has been some effort to ease the transition by allowing PostgreSQL to recognize the deprecated type names and translate them to the new type names, this mechanism cannot be completely transparent to your existing application.

.. versionadded:: 7.0
    The date/time types datetime and timespan have been superseded
    by the SQL92-defined types timestamp and interval. Although
    there has been some effort to ease the transition by allowing
    PostgreSQL to recognize the deprecated type names and translate
    them to the new type names, this mechanism cannot be completely
    transparent to your existing application.

Added in version 7.0: The date/time types datetime and timespan have been superseded by the SQL92-defined types timestamp and interval. Although there has been some effort to ease the transition by allowing PostgreSQL to recognize the deprecated type names and translate them to the new type names, this mechanism cannot be completely transparent to your existing application.

:::{versionchanged} 7.0
The date/time types datetime and timespan have been superseded by
the SQL92-defined types timestamp and interval. Although there has
been some effort to ease the transition by allowing PostgreSQL to
recognize the deprecated type names and translate them to the new
type names, this mechanism cannot be completely transparent to your
existing application.
:::

Changed in version 7.0: The date/time types datetime and timespan have been superseded by the SQL92-defined types timestamp and interval. Although there has been some effort to ease the transition by allowing PostgreSQL to recognize the deprecated type names and translate them to the new type names, this mechanism cannot be completely transparent to your existing application.

.. versionchanged:: 7.0
    The date/time types datetime and timespan have been superseded
    by the SQL92-defined types timestamp and interval. Although
    there has been some effort to ease the transition by allowing
    PostgreSQL to recognize the deprecated type names and translate
    them to the new type names, this mechanism cannot be completely
    transparent to your existing application.

Changed in version 7.0: The date/time types datetime and timespan have been superseded by the SQL92-defined types timestamp and interval. Although there has been some effort to ease the transition by allowing PostgreSQL to recognize the deprecated type names and translate them to the new type names, this mechanism cannot be completely transparent to your existing application.

:::{deprecated} 7.0
The date/time types datetime and timespan have been superseded by
the SQL92-defined types timestamp and interval. Although there has
been some effort to ease the transition by allowing PostgreSQL to
recognize the deprecated type names and translate them to the new
type names, this mechanism cannot be completely transparent to your
existing application.
:::

Deprecated since version 7.0: The date/time types datetime and timespan have been superseded by the SQL92-defined types timestamp and interval. Although there has been some effort to ease the transition by allowing PostgreSQL to recognize the deprecated type names and translate them to the new type names, this mechanism cannot be completely transparent to your existing application.

.. deprecated:: 7.0
    The date/time types datetime and timespan have been superseded
    by the SQL92-defined types timestamp and interval. Although
    there has been some effort to ease the transition by allowing
    PostgreSQL to recognize the deprecated type names and translate
    them to the new type names, this mechanism cannot be completely
    transparent to your existing application.

Deprecated since version 7.0: The date/time types datetime and timespan have been superseded by the SQL92-defined types timestamp and interval. Although there has been some effort to ease the transition by allowing PostgreSQL to recognize the deprecated type names and translate them to the new type names, this mechanism cannot be completely transparent to your existing application.

:::{versionremoved} 7.0
The date/time types datetime and timespan have been superseded by
the SQL92-defined types timestamp and interval. Although there has
been some effort to ease the transition by allowing PostgreSQL to
recognize the deprecated type names and translate them to the new
type names, this mechanism cannot be completely transparent to your
existing application.
:::

Removed in version 7.0: The date/time types datetime and timespan have been superseded by the SQL92-defined types timestamp and interval. Although there has been some effort to ease the transition by allowing PostgreSQL to recognize the deprecated type names and translate them to the new type names, this mechanism cannot be completely transparent to your existing application.

.. versionremoved:: 7.0
    The date/time types datetime and timespan have been superseded
    by the SQL92-defined types timestamp and interval. Although
    there has been some effort to ease the transition by allowing
    PostgreSQL to recognize the deprecated type names and translate
    them to the new type names, this mechanism cannot be completely
    transparent to your existing application.

Removed in version 7.0: The date/time types datetime and timespan have been superseded by the SQL92-defined types timestamp and interval. Although there has been some effort to ease the transition by allowing PostgreSQL to recognize the deprecated type names and translate them to the new type names, this mechanism cannot be completely transparent to your existing application.