diff --git a/doc/source/reference/kwant.rst b/doc/source/reference/kwant.rst index 61a3d5260829843307e6440bd95be33bb8aaea2c..e429f81d8fc7863a12f21b12b4c08e88f4378185 100644 --- a/doc/source/reference/kwant.rst +++ b/doc/source/reference/kwant.rst @@ -9,7 +9,21 @@ Otherwise, this package has only very limited functionality of its own. Generic functionality --------------------- +.. + TODO: Once we depend on Sphinx 1.8, the documentation of __version__ can be + put into the "docstring": https://github.com/sphinx-doc/sphinx/issues/344 + The version of Kwant is available under the name ``__version__``. +This string respects `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_ +and has the following format + +- Released version: '1.3.0', '1.3.1', etc. +- Alpha version: '1.2.0a0', '1.2.0a1', etc. +- Beta version: '1.1.0b0', '1.1.0b1', etc. +- Development version (derived from ``git describe --first-parent --dirty``): + '1.3.2.dev27+gdecf6893', '1.1.1.dev10+gabcd012.dirty', etc. +- Development version with incomplete information: 'unknown', + 'unknown+g0123abc', etc. .. autosummary:: :toctree: generated/