diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2014-08-25 12:03:48 -0400 |
|---|---|---|
| committer | Doug Hellmann <doug@doughellmann.com> | 2014-08-25 12:03:48 -0400 |
| commit | cea0814cbe3a5e491cfa05af34a9eea40163dbf0 (patch) | |
| tree | c49b943a59fdec9ee67ec14987e62546ecda69de | |
| parent | 025c004c26cd9bf29a867de30b1591abceb85b90 (diff) | |
| download | oslo-serialization-cea0814cbe3a5e491cfa05af34a9eea40163dbf0.tar.gz | |
Clean up docs before first release
Add basic API documentation and release notes.
Change-Id: I18fc06d23d8e46baf153a150e6af896c7bb67f04
| -rw-r--r-- | README.rst | 8 | ||||
| -rw-r--r-- | doc/source/api.rst | 9 | ||||
| -rw-r--r-- | doc/source/history.rst | 2 | ||||
| -rw-r--r-- | doc/source/index.rst | 26 | ||||
| -rw-r--r-- | doc/source/usage.rst | 7 |
5 files changed, 25 insertions, 27 deletions
@@ -1,10 +1,10 @@ -=================================== -oslo.serialization -=================================== +==================== + oslo.serialization +==================== oslo.serialization library * Free software: Apache license * Documentation: http://docs.openstack.org/developer/oslo.serialization * Source: http://git.openstack.org/cgit/openstack/oslo.serialization -* Bugs: http://bugs.launchpad.net/oslo
\ No newline at end of file +* Bugs: http://bugs.launchpad.net/oslo diff --git a/doc/source/api.rst b/doc/source/api.rst new file mode 100644 index 0000000..da1af8e --- /dev/null +++ b/doc/source/api.rst @@ -0,0 +1,9 @@ +===== + API +===== + +jsonutils +========= + +.. automodule:: oslo.serialization.jsonutils + :members: diff --git a/doc/source/history.rst b/doc/source/history.rst new file mode 100644 index 0000000..db8340b --- /dev/null +++ b/doc/source/history.rst @@ -0,0 +1,2 @@ +.. include:: ../../ChangeLog + diff --git a/doc/source/index.rst b/doc/source/index.rst index 601e4e6..645fb74 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,24 +1,18 @@ -.. oslo.serialization documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +==================== + oslo.serialization +==================== -Welcome to oslo.serialization's documentation! -=============================================================== +An OpenStack library for representing objects in transmittable and +storable formats. -Contents: +Contents +======== .. toctree:: - :maxdepth: 2 + :maxdepth: 1 readme installation - usage + api + history contributing - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index aacca33..0000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,7 +0,0 @@ -======== -Usage -======== - -To use oslo.serialization in a project:: - - from oslo import serialization
\ No newline at end of file |