diff options
| author | Victor Stinner <vstinner@redhat.com> | 2015-10-15 14:57:35 +0200 |
|---|---|---|
| committer | Victor Stinner <vstinner@redhat.com> | 2015-10-17 10:53:34 +0200 |
| commit | 7f57de5bb28b33bf321904e3171e9bb45116ddfa (patch) | |
| tree | 7af2eef4dfb719f53c8b61045f0fd5a10a7fba4a /doc | |
| parent | 6aa24675e890e0bb61967a3e4c5e6aa8cf3dedcf (diff) | |
| download | oslo-utils-7f57de5bb28b33bf321904e3171e9bb45116ddfa.tar.gz | |
Use versionadded and versionchanged in doc
Document in which version new types and functions were added using
".. versionadded:: x.y". Document changes using
".. versionchanged:: x.y."
For new modules, add the versionadded tag in the module top
docstring, not on each type/function.
Add fileutils to documentation. The doc part was forgotten during the
graduation.
Add docstrings to convert versions of versionutils.
I used "git blame" + "git tag --contains=SHA1" to find these version,
and then I checked manually each version.
Change-Id: Ia2f00aa29eb36410a49fc1d350896a569a7737a1
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/api/fileutils.rst | 7 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 |
2 files changed, 8 insertions, 0 deletions
diff --git a/doc/source/api/fileutils.rst b/doc/source/api/fileutils.rst new file mode 100644 index 0000000..575bedf --- /dev/null +++ b/doc/source/api/fileutils.rst @@ -0,0 +1,7 @@ +============= + fileutils +============= + +.. automodule:: oslo_utils.fileutils + :members: + diff --git a/doc/source/index.rst b/doc/source/index.rst index 4a9e6db..9f00c10 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -21,6 +21,7 @@ API Documentation api/encodeutils api/eventletutils api/excutils + api/fileutils api/fixture api/importutils api/netutils |