diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 65e85d3..15ce1e8 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,16 +1,13 @@ If you would like to contribute to the development of OpenStack, you must follow the steps in this page: - - http://docs.openstack.org/infra/manual/developers.html +http://docs.openstack.org/infra/manual/developers.html Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at: - - http://docs.openstack.org/infra/manual/developers.html#development-workflow +http://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: - - https://bugs.launchpad.net/oslo.versionedobjects +https://bugs.launchpad.net/oslo.versionedobjects diff --git a/doc/source/opts.rst b/doc/source/configuration/index.rst similarity index 100% rename from doc/source/opts.rst rename to doc/source/configuration/index.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 53% rename from doc/source/contributing.rst rename to doc/source/contributor/index.rst index 2ca75d1..ed5290b 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -2,4 +2,4 @@ Contributing ============== -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index cf1e355..659058d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,29 +13,18 @@ upgrade compatibility across distributed services. * Source: http://git.openstack.org/cgit/openstack/oslo.versionedobjects * Bugs: http://bugs.launchpad.net/oslo.versionedobjects -Contents -======== +---- .. toctree:: :maxdepth: 2 - installation - api/index - usage - examples - opts - contributing + install/index + user/index + configuration/index + reference/index + contributor/index -Release Notes -============= - -.. toctree:: - :maxdepth: 1 - - history - -Indices and tables -================== +.. rubric:: Indices and tables * :ref:`genindex` * :ref:`modindex` diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/doc/source/api/base.rst b/doc/source/reference/base.rst similarity index 100% rename from doc/source/api/base.rst rename to doc/source/reference/base.rst diff --git a/doc/source/api/exception.rst b/doc/source/reference/exception.rst similarity index 100% rename from doc/source/api/exception.rst rename to doc/source/reference/exception.rst diff --git a/doc/source/api/fields.rst b/doc/source/reference/fields.rst similarity index 100% rename from doc/source/api/fields.rst rename to doc/source/reference/fields.rst diff --git a/doc/source/api/fixture.rst b/doc/source/reference/fixture.rst similarity index 100% rename from doc/source/api/fixture.rst rename to doc/source/reference/fixture.rst diff --git a/doc/source/api/index.rst b/doc/source/reference/index.rst similarity index 52% rename from doc/source/api/index.rst rename to doc/source/reference/index.rst index f193e3b..2b99fef 100644 --- a/doc/source/api/index.rst +++ b/doc/source/reference/index.rst @@ -1,6 +1,6 @@ -===== - API -===== +============= +API Reference +============= .. toctree:: :maxdepth: 2 diff --git a/doc/source/examples.rst b/doc/source/user/examples.rst similarity index 92% rename from doc/source/examples.rst rename to doc/source/user/examples.rst index 5317d77..8ea27f0 100644 --- a/doc/source/examples.rst +++ b/doc/source/user/examples.rst @@ -9,7 +9,7 @@ IOT lightbulb Full source located at :example:`iot_bulb`. -.. literalinclude:: ../../oslo_versionedobjects/examples/iot_bulb.py +.. literalinclude:: ../../../oslo_versionedobjects/examples/iot_bulb.py :language: python :linenos: :lines: 14- diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 0000000..f69be70 --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..5ef5ef9 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,15 @@ +=========================== +Using oslo.versionedobjects +=========================== + +.. toctree:: + :maxdepth: 2 + + usage + examples + +.. history contains a lot of sections, toctree with maxdepth 1 is used. +.. toctree:: + :maxdepth: 1 + + history diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/usage.rst diff --git a/oslo_versionedobjects/base.py b/oslo_versionedobjects/base.py index 7df5e52..d07ba94 100644 --- a/oslo_versionedobjects/base.py +++ b/oslo_versionedobjects/base.py @@ -1129,7 +1129,7 @@ def obj_tree_get_versions(objname, tree=None): level object with other objects as fields. It walks the tree recursively to determine all the objects (by symbolic name) that could be contained within the top-level object, and the maximum versions of each. The result - is a dict like: + is a dict like:: {'MyObject': '1.23', ... } diff --git a/oslo_versionedobjects/fields.py b/oslo_versionedobjects/fields.py index 45dad72..d4d4996 100644 --- a/oslo_versionedobjects/fields.py +++ b/oslo_versionedobjects/fields.py @@ -1036,7 +1036,7 @@ class UUIDField(AutoTypedField): your own objects/fields.py :Example: - .. code-block:: python + .. code-block:: python import oslo_versionedobjects.fields as ovo_fields @@ -1049,8 +1049,8 @@ class UUIDField(AutoTypedField): class UUIDField(ovo_fields.AutoTypedField): AUTO_TYPE = UUID() - and then in your objects use - ``.object.fields.UUIDField``. + and then in your objects use + ``.object.fields.UUIDField``. This will become default behaviour in the future. """