Clean up docs before first release

Add basic API documentation and release notes.

Change-Id: I18fc06d23d8e46baf153a150e6af896c7bb67f04
This commit is contained in:
Doug Hellmann 2014-08-25 12:03:48 -04:00
parent 025c004c26
commit cea0814cbe
5 changed files with 25 additions and 27 deletions

View File

@ -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
* Bugs: http://bugs.launchpad.net/oslo

9
doc/source/api.rst Normal file
View File

@ -0,0 +1,9 @@
=====
API
=====
jsonutils
=========
.. automodule:: oslo.serialization.jsonutils
:members:

2
doc/source/history.rst Normal file
View File

@ -0,0 +1,2 @@
.. include:: ../../ChangeLog

View File

@ -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`

View File

@ -1,7 +0,0 @@
========
Usage
========
To use oslo.serialization in a project::
from oslo import serialization