From 2e060b3e58f9924636bcf892565c7c12ea1bc4b1 Mon Sep 17 00:00:00 2001 From: TerryHowe Date: Mon, 2 Mar 2015 10:01:53 -0700 Subject: [PATCH] Fix glossary and other 404s The glossary was not being generated and there were a few other 404s and warnings that are fixed. Removed old TODO. The glossary could use some more work, but that TODO had become meaningless. Change-Id: I7b6c0dc18c46d29a8edc85d22723acb3a25a2c26 --- doc/source/conf.py | 4 +--- doc/source/contributors/index.rst | 2 +- doc/source/{users => }/glossary.rst | 3 +-- doc/source/index.rst | 3 +++ doc/source/users/index.rst | 2 +- doc/source/users/resources/network/index.rst | 2 +- openstack/resource.py | 4 ++-- 7 files changed, 10 insertions(+), 10 deletions(-) rename doc/source/{users => }/glossary.rst (96%) diff --git a/doc/source/conf.py b/doc/source/conf.py index 2113f6271..6381804c8 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -53,9 +53,7 @@ pygments_style = 'sphinx' autodoc_member_order = "bysource" # Locations to exclude when looking for source files. -# * Glossary is not included in any toctree, so it raised warnings, but it -# is explicitly linked to from the top of users/index.rst. -exclude_patterns = ["users/glossary.rst"] +exclude_patterns = [] # -- Options for HTML output -------------------------------------------------- diff --git a/doc/source/contributors/index.rst b/doc/source/contributors/index.rst index 08c071800..8f85b340d 100644 --- a/doc/source/contributors/index.rst +++ b/doc/source/contributors/index.rst @@ -38,7 +38,7 @@ Development Environment The first step towards contributing code and documentation is to setup your development environment. We use a pretty standard setup, but it is fully -documented in our `setup `_ section. +documented in our `setup `_ section. .. toctree:: :maxdepth: 2 diff --git a/doc/source/users/glossary.rst b/doc/source/glossary.rst similarity index 96% rename from doc/source/users/glossary.rst rename to doc/source/glossary.rst index 34a974448..3bdbde41d 100644 --- a/doc/source/users/glossary.rst +++ b/doc/source/glossary.rst @@ -1,5 +1,4 @@ -.. TODO(dtroyer): Resource needs further fleshing out, revise once the -.. object model in the SDK is finalized. +:orphan: Glossary ======== diff --git a/doc/source/index.rst b/doc/source/index.rst index 37fd8c769..3b0565b79 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -21,3 +21,6 @@ For Contributors :maxdepth: 2 contributors/index + +For a listing of terms used throughout the SDK, including the names of +projects and services supported by it, see the `Glossary `_. diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst index 1eb400bf9..4bd7f265a 100644 --- a/doc/source/users/index.rst +++ b/doc/source/users/index.rst @@ -2,7 +2,7 @@ Getting started with the OpenStack SDK ====================================== For a listing of terms used throughout the SDK, including the names of -projects and services supported by it, see the `Glossary `_. +projects and services supported by it, see the `Glossary <../glossary.html>`_. Installation ------------ diff --git a/doc/source/users/resources/network/index.rst b/doc/source/users/resources/network/index.rst index 197c4e113..53cd89bf8 100644 --- a/doc/source/users/resources/network/index.rst +++ b/doc/source/users/resources/network/index.rst @@ -5,7 +5,7 @@ Network Resources :maxdepth: 1 v2/extension - v2/floatingip + v2/floating_ip v2/health_monitor v2/listener v2/load_balancer diff --git a/openstack/resource.py b/openstack/resource.py index 86446cdf4..5d72f9c44 100644 --- a/openstack/resource.py +++ b/openstack/resource.py @@ -339,8 +339,8 @@ class Resource(collections.MutableMapping): :rtype: :class:`~openstack.resource.Resource` or the appropriate subclass. - :raises: :exc:`ValueError` if ``value`` is not an instance of - this Resource type or a valid ``name``. + :raises: :exc:`ValueError` if ``value`` is not an instance of + this Resource type or a valid ``name``. """ return cls._from_attr(cls.name_attribute, value)