diff options
| author | Nejc Saje <nsaje@redhat.com> | 2014-08-25 06:22:17 -0400 |
|---|---|---|
| committer | Nejc Saje <nsaje@redhat.com> | 2014-08-27 12:03:21 -0400 |
| commit | 69da9cd23165606b4b072dbe6653bf968b32ffaf (patch) | |
| tree | 7f771620613d32f597f4b6d851c85898d7097654 /doc/source/conf.py | |
| parent | 98127c4e40a37353fe486483ffc9b8ac25c27474 (diff) | |
| download | python-ceilometerclient-69da9cd23165606b4b072dbe6653bf968b32ffaf.tar.gz | |
Revamp documentation, add module references
Documentation is modeled after python-novaclient docs.
(http://docs.openstack.org/developer/python-novaclient/)
Built preview for reviewers:
https://nsaje.fedorapeople.org/python-ceilometerclient/
Change-Id: I61e9d6593e4a1aea5cf018081416d4be3a9372ac
Diffstat (limited to 'doc/source/conf.py')
| -rw-r--r-- | doc/source/conf.py | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 185f758..7124622 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,7 +1,27 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at # +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import os +execfile(os.path.join("..", "ext", "gen_ref.py")) project = 'python-ceilometerclient' +gen_ref("", "Client Reference", ["client", "exc"]) +gen_ref("v1", "Version 1 API Reference", + ["meters"]) +gen_ref("v2", "Version 2 API Reference", + ["meters", "samples", "statistics", "resources", "query", "alarms", + "events", "event_types", "traits", "trait_descriptions"]) + # -- General configuration ---------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be |
