openstack/aodh
Code Issues Proposed changes

Fix warnings in the documentation build

Browse Source 
Some of the docstrings pulled into the API documentation
were malformatted, so fix those. Also include the API
documentation in a toctree so it is linked in the
"Contributing" section of the documentation.

Change-Id: I8eef6007045d5426299dadb67303102855c15dc2
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
This commit is contained in:
Doug Hellmann 2013-01-04 18:31:27 -05:00
parent cd0f6c28f1
commit 3a8051d876
7 changed files with 90 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -12,5 +12,7 @@ ChangeLog
dist dist
*.egg *.egg
ceilometer/versioninfo ceilometer/versioninfo
doc/source/api/*.rst doc/source/api/ceilometer.*.rst
doc/source/api/tests.*.rst
doc/source/api/autoindex.rst
*.mo *.mo

40
ceilometer/storage/impl_mongodb.py
View File

@ -36,27 +36,27 @@ LOG = log.getLogger(__name__)
class MongoDBStorage(base.StorageEngine): class MongoDBStorage(base.StorageEngine):
"""Put the data into a MongoDB database """Put the data into a MongoDB database
Collections: Collections::
- user - user
- { _id: user id - { _id: user id
source: [ array of source ids reporting for the user ] source: [ array of source ids reporting for the user ]
} }
- project - project
- { _id: project id - { _id: project id
source: [ array of source ids reporting for the project ] source: [ array of source ids reporting for the project ]
} }
- meter - meter
- the raw incoming data - the raw incoming data
- resource - resource
- the metadata for resources - the metadata for resources
- { _id: uuid of resource, - { _id: uuid of resource,
metadata: metadata dictionaries metadata: metadata dictionaries
timestamp: datetime of last update timestamp: datetime of last update
user_id: uuid user_id: uuid
project_id: uuid project_id: uuid
meter: [ array of {counter_name: string, counter_type: string} ] meter: [ array of {counter_name: string, counter_type: string} ]
} }
""" """
OPTIONS = [] OPTIONS = []

76
ceilometer/storage/impl_sqlalchemy.py
View File

@ -33,45 +33,45 @@ LOG = log.getLogger(__name__)
class SQLAlchemyStorage(base.StorageEngine): class SQLAlchemyStorage(base.StorageEngine):
"""Put the data into a SQLAlchemy database """Put the data into a SQLAlchemy database
Tables: Tables::
- user - user
- { id: user uuid } - { id: user uuid }
- source - source
- { id: source id } - { id: source id }
- project - project
- { id: project uuid } - { id: project uuid }
- meter - meter
- the raw incoming data - the raw incoming data
- { id: meter id - { id: meter id
counter_name: counter name counter_name: counter name
user_id: user uuid (->user.id) user_id: user uuid (->user.id)
project_id: project uuid (->project.id) project_id: project uuid (->project.id)
resource_id: resource uuid (->resource.id) resource_id: resource uuid (->resource.id)
resource_metadata: metadata dictionaries resource_metadata: metadata dictionaries
counter_type: counter type counter_type: counter type
counter_volume: counter volume counter_volume: counter volume
timestamp: datetime timestamp: datetime
message_signature: message signature message_signature: message signature
message_id: message uuid message_id: message uuid
} }
- resource - resource
- the metadata for resources - the metadata for resources
- { id: resource uuid - { id: resource uuid
resource_metadata: metadata dictionaries resource_metadata: metadata dictionaries
received_timestamp: received datetime received_timestamp: received datetime
timestamp: datetime timestamp: datetime
project_id: project uuid (->project.id) project_id: project uuid (->project.id)
user_id: user uuid (->user.id) user_id: user uuid (->user.id)
} }
- sourceassoc - sourceassoc
- the relationships - the relationships
- { meter_id: meter id (->meter.id) - { meter_id: meter id (->meter.id)
project_id: project uuid (->project.id) project_id: project uuid (->project.id)
resource_id: resource uuid (->resource.id) resource_id: resource uuid (->resource.id)
user_id: user uuid (->user.id) user_id: user uuid (->user.id)
source_id: source id (->source.id) source_id: source id (->source.id)
} }
""" """
OPTIONS = [] OPTIONS = []

40
ceilometer/storage/impl_test.py
View File

@ -36,27 +36,27 @@ class TestDBStorage(base.StorageEngine):
This driver is based on MIM, an in-memory version of MongoDB. This driver is based on MIM, an in-memory version of MongoDB.
Collections: Collections::
- user - user
- { _id: user id - { _id: user id
source: [ array of source ids reporting for the user ] source: [ array of source ids reporting for the user ]
} }
- project - project
- { _id: project id - { _id: project id
source: [ array of source ids reporting for the project ] source: [ array of source ids reporting for the project ]
} }
- meter - meter
- the raw incoming data - the raw incoming data
- resource - resource
- the metadata for resources - the metadata for resources
- { _id: uuid of resource, - { _id: uuid of resource,
metadata: metadata dictionaries metadata: metadata dictionaries
timestamp: datetime of last update timestamp: datetime of last update
user_id: uuid user_id: uuid
project_id: uuid project_id: uuid
meter: [ array of {counter_name: string, counter_type: string} ] meter: [ array of {counter_name: string, counter_type: string} ]
} }
""" """
OPTIONS = [] OPTIONS = []

8
doc/source/api/index.rst Normal file
View File

@ -0,0 +1,8 @@
======================
Internal API Reference
======================
.. toctree::
:maxdepth: 1
autoindex

1
doc/source/contributing/index.rst
View File

@ -24,3 +24,4 @@
areas areas
source source
plugins plugins
../api/index

1
doc/source/index.rst
View File

@ -53,7 +53,6 @@ Table of contents
webapi/index webapi/index
contributing/index contributing/index
releasenotes/index releasenotes/index
api/index
glossary glossary
.. - installation .. - installation