diff options
author | Doug Hellmann <doug@doughellmann.com> | 2014-07-23 16:05:59 -0400 |
---|---|---|
committer | Doug Hellmann <doug@doughellmann.com> | 2014-07-23 16:05:59 -0400 |
commit | 3a09189098f19724a896566fa962b26653e85f89 (patch) | |
tree | b7caa40618e3eb792fc932241dec76090dc01432 /doc | |
parent | 51e6c14a75d79edd16a405b05d18c30d6bfd7d49 (diff) | |
download | oslo-utils-3a09189098f19724a896566fa962b26653e85f89.tar.gz |
Add API docs and clean up other docs
Add auto-generated documentation for the public modules in the library
and clean up a bit of the docstrings used.
Change-Id: Id5efa5c413b82e13f1a7ac78c92e39c193f12214
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/api/encodeutils.rst | 6 | ||||
-rw-r--r-- | doc/source/api/excutils.rst | 6 | ||||
-rw-r--r-- | doc/source/api/importutils.rst | 6 | ||||
-rw-r--r-- | doc/source/api/index.rst | 9 | ||||
-rw-r--r-- | doc/source/api/netutils.rst | 6 | ||||
-rw-r--r-- | doc/source/api/strutils.rst | 6 | ||||
-rw-r--r-- | doc/source/api/timeutils.rst | 6 | ||||
-rw-r--r-- | doc/source/api/units.rst | 6 | ||||
-rw-r--r-- | doc/source/contributing.rst | 6 | ||||
-rw-r--r-- | doc/source/index.rst | 1 | ||||
-rw-r--r-- | doc/source/readme.rst | 2 | ||||
-rw-r--r-- | doc/source/usage.rst | 13 |
12 files changed, 66 insertions, 7 deletions
diff --git a/doc/source/api/encodeutils.rst b/doc/source/api/encodeutils.rst new file mode 100644 index 0000000..82ca596 --- /dev/null +++ b/doc/source/api/encodeutils.rst @@ -0,0 +1,6 @@ +============= + encodeutils +============= + +.. automodule:: oslo.utils.encodeutils + :members: diff --git a/doc/source/api/excutils.rst b/doc/source/api/excutils.rst new file mode 100644 index 0000000..d39be38 --- /dev/null +++ b/doc/source/api/excutils.rst @@ -0,0 +1,6 @@ +========== + excutils +========== + +.. automodule:: oslo.utils.excutils + :members: diff --git a/doc/source/api/importutils.rst b/doc/source/api/importutils.rst new file mode 100644 index 0000000..0864d92 --- /dev/null +++ b/doc/source/api/importutils.rst @@ -0,0 +1,6 @@ +============= + importutils +============= + +.. automodule:: oslo.utils.importutils + :members: diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst new file mode 100644 index 0000000..f193e3b --- /dev/null +++ b/doc/source/api/index.rst @@ -0,0 +1,9 @@ +===== + API +===== + +.. toctree:: + :maxdepth: 2 + :glob: + + * diff --git a/doc/source/api/netutils.rst b/doc/source/api/netutils.rst new file mode 100644 index 0000000..bb50442 --- /dev/null +++ b/doc/source/api/netutils.rst @@ -0,0 +1,6 @@ +========== + netutils +========== + +.. automodule:: oslo.utils.netutils + :members: diff --git a/doc/source/api/strutils.rst b/doc/source/api/strutils.rst new file mode 100644 index 0000000..bd2531b --- /dev/null +++ b/doc/source/api/strutils.rst @@ -0,0 +1,6 @@ +========== + strutils +========== + +.. automodule:: oslo.utils.strutils + :members: diff --git a/doc/source/api/timeutils.rst b/doc/source/api/timeutils.rst new file mode 100644 index 0000000..d1292b3 --- /dev/null +++ b/doc/source/api/timeutils.rst @@ -0,0 +1,6 @@ +=========== + timeutils +=========== + +.. automodule:: oslo.utils.timeutils + :members: diff --git a/doc/source/api/units.rst b/doc/source/api/units.rst new file mode 100644 index 0000000..edd1bed --- /dev/null +++ b/doc/source/api/units.rst @@ -0,0 +1,6 @@ +======= + units +======= + +.. automodule:: oslo.utils.units + :members: diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 8cb3146..2ca75d1 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1 +1,5 @@ -.. include:: ../../CONTRIBUTING.rst
\ No newline at end of file +============== + Contributing +============== + +.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 211999d..720896a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,6 +9,7 @@ Contents: readme installation usage + api/index contributing Indices and tables diff --git a/doc/source/readme.rst b/doc/source/readme.rst index 6b2b3ec..a6210d3 100644 --- a/doc/source/readme.rst +++ b/doc/source/readme.rst @@ -1 +1 @@ -.. include:: ../README.rst
\ No newline at end of file +.. include:: ../../README.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 35bb227..9e83f6b 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,7 +1,10 @@ -======== -Usage -======== +========= + Usage +========= -To use oslo.utils in a project:: +To use oslo.utils in a project, import the individual module you +need. For example:: - import oslo.utils
\ No newline at end of file + from oslo.utils import strutils + + slug = strutils.to_slug('input value') |