Add pypi download + version badges
Also makes the docs look more like the other oslo libraries so that the content is easily readable across projects. Change-Id: I2a3497bcbf72bc4a0e6fb12f7c2d508bb3a4e6bc
This commit is contained in:
parent
d6782d9b39
commit
5b4e919879
10
README.rst
10
README.rst
@ -2,7 +2,15 @@
|
||||
oslo.serialization
|
||||
====================
|
||||
|
||||
The Oslo Serialization library provides support for representing objects
|
||||
.. image:: https://pypip.in/version/oslo.serialization/badge.svg
|
||||
:target: https://pypi.python.org/pypi/oslo.serialization/
|
||||
:alt: Latest Version
|
||||
|
||||
.. image:: https://pypip.in/download/oslo.serialization/badge.svg?period=month
|
||||
:target: https://pypi.python.org/pypi/oslo.serialization/
|
||||
:alt: Downloads
|
||||
|
||||
The oslo.serialization library provides support for representing objects
|
||||
in transmittable and storable formats, such as JSON and MessagePack.
|
||||
|
||||
* Free software: Apache license
|
||||
|
@ -1,9 +1,11 @@
|
||||
=====
|
||||
API
|
||||
=====
|
||||
|
||||
jsonutils
|
||||
=========
|
||||
|
||||
.. automodule:: oslo_serialization.jsonutils
|
||||
:members:
|
||||
|
||||
msgpackutils
|
||||
============
|
||||
|
||||
.. automodule:: oslo_serialization.msgpackutils
|
||||
:members:
|
||||
|
@ -1,19 +1,30 @@
|
||||
====================
|
||||
oslo.serialization
|
||||
====================
|
||||
==============================================
|
||||
Welcome to oslo.serialization's documentation!
|
||||
==============================================
|
||||
|
||||
An OpenStack library for representing objects in transmittable and
|
||||
storable formats.
|
||||
|
||||
Contents
|
||||
========
|
||||
The `oslo`_ serialization library provides support for representing objects
|
||||
in transmittable and storable formats, such as JSON and MessagePack.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
readme
|
||||
installation
|
||||
api
|
||||
history
|
||||
contributing
|
||||
history
|
||||
|
||||
API Documentation
|
||||
=================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
.. _oslo: https://wiki.openstack.org/wiki/Oslo
|
||||
|
@ -1 +0,0 @@
|
||||
.. include:: ../../README.rst
|
Loading…
x
Reference in New Issue
Block a user