From eaf180c68dc7cba866df0c70199ae48fb382c6e0 Mon Sep 17 00:00:00 2001 From: Pete Zaitcev Date: Mon, 3 Jun 2019 22:00:41 -0500 Subject: [PATCH] Fix a few Sphinx warnings This precludes us from landing anything in the gate, because we treat Sphinx warnings as errors in OpenStack. Specifically, 3 warnings are fixed: /home/zuul/src/opendev.org/openstack/swift/swift/common/middleware\ /s3api/etree.py:docstring of\ swift.common.middleware.s3api.etree.Element:1:\ Inline strong start-string without end-string. duplicate object description of\ swift.common.middleware.versioned_writes, other instance in\ middleware, use :noindex: for one of them duplicate object description of\ swift.common.ring.composite_builder, other instance in\ overview_ring, use :noindex: for one of them Change-Id: I5e0bd61a301d46b2674b4605882462575b635220 --- doc/source/index.rst | 1 - doc/source/middleware.rst | 2 +- doc/source/overview_object_versioning.rst | 5 ----- doc/source/overview_ring.rst | 3 ++- doc/source/ring.rst | 2 ++ 5 files changed, 5 insertions(+), 8 deletions(-) delete mode 100644 doc/source/overview_object_versioning.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 199be4e0d6..d2b1ea38ab 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -53,7 +53,6 @@ Overview and Concepts overview_replication ratelimit overview_large_objects - overview_object_versioning overview_global_cluster overview_container_sync overview_expiring_objects diff --git a/doc/source/middleware.rst b/doc/source/middleware.rst index 8b4752104a..83e8c6a870 100644 --- a/doc/source/middleware.rst +++ b/doc/source/middleware.rst @@ -37,7 +37,7 @@ AWS S3 Api :show-inheritance: .. automodule:: swift.common.middleware.s3api.etree - :members: + :members: _Element :show-inheritance: .. automodule:: swift.common.middleware.s3api.utils diff --git a/doc/source/overview_object_versioning.rst b/doc/source/overview_object_versioning.rst deleted file mode 100644 index db1d5e9778..0000000000 --- a/doc/source/overview_object_versioning.rst +++ /dev/null @@ -1,5 +0,0 @@ -Object Versioning -================= - -.. automodule:: swift.common.middleware.versioned_writes - :show-inheritance: diff --git a/doc/source/overview_ring.rst b/doc/source/overview_ring.rst index 58ccc95499..5d88013de4 100644 --- a/doc/source/overview_ring.rst +++ b/doc/source/overview_ring.rst @@ -359,7 +359,8 @@ can't get perfect balance due to too many partitions recently moved). --------------- Composite Rings --------------- -.. automodule:: swift.common.ring.composite_builder + +See :ref:`composite_builder`. ********************************** swift-ring-composer (Experimental) diff --git a/doc/source/ring.rst b/doc/source/ring.rst index cbb5e97d96..c65290d2be 100644 --- a/doc/source/ring.rst +++ b/doc/source/ring.rst @@ -24,6 +24,8 @@ Ring Builder :undoc-members: :show-inheritance: +.. _composite_builder: + Composite Ring Builder ======================