Fix warnings in the documentation build

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

4
.gitignore vendored
View File

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

View File

@ -36,7 +36,7 @@ LOG = log.getLogger(__name__)
class MongoDBStorage(base.StorageEngine):
"""Put the data into a MongoDB database
Collections:
Collections::
- user
- { _id: user id

View File

@ -33,7 +33,7 @@ LOG = log.getLogger(__name__)
class SQLAlchemyStorage(base.StorageEngine):
"""Put the data into a SQLAlchemy database
Tables:
Tables::
- user
- { id: user uuid }

View File

@ -36,7 +36,7 @@ class TestDBStorage(base.StorageEngine):
This driver is based on MIM, an in-memory version of MongoDB.
Collections:
Collections::
- user
- { _id: user id

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

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

View File

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

View File

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