[openstack-dev] [oslo] Document API changes using Sphinx markups

Victor Stinner vstinner at redhat.com
Tue Jul 7 15:22:26 UTC 2015


Oslo libraries become more and more stable, cool :-) Sometimes, we have 
to modify APIs, to fix bugs, to deprecate functions, to add new function 
parameters, etc. It would be cool to _document_ these changes. Sphinx 
provides nice markups to document API changes:


We can try to ensure that API changes are documented in reviews, or 
maybe also document old changes.


.. versionadded:: 2.5
    The *spam* parameter.

.. versionadded:: 2.6
    The function now returns an integer.

.. deprecated:: 3.1
    Use :func:`spam` instead.

I noticed that the deprecated markup is already used in oslo.utils doc:



More information about the OpenStack-dev mailing list