From 69da9cd23165606b4b072dbe6653bf968b32ffaf Mon Sep 17 00:00:00 2001 From: Nejc Saje Date: Mon, 25 Aug 2014 06:22:17 -0400 Subject: 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 --- doc/source/conf.py | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'doc/source/conf.py') 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 -- cgit v1.2.1