[ckan-dev] Docs tip: versionadded and versionchanged

Sean Hammond sean.hammond at okfn.org
Mon Apr 22 11:42:22 UTC 2013


Hey, just a quick tip for anyone writing docs, use Sphinx's versionadded
directive for any feature new in 2.0 and versionchanged for anything
that has changed:

http://sphinx-doc.org/markup/para.html

You can just put ".. versionadded:: 2.0" at the top of a section
documenting a new feature. Optionally you can give a one-line
explanation of what was added/changed:

    Authorization
    ============

    .. versionchanged:: 2.0
       Previous versions of CKAN had a completely different authorization system.




More information about the ckan-dev mailing list