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
This commit is contained in:
parent
4f9595f113
commit
eaf180c68d
@ -53,7 +53,6 @@ Overview and Concepts
|
|||||||
overview_replication
|
overview_replication
|
||||||
ratelimit
|
ratelimit
|
||||||
overview_large_objects
|
overview_large_objects
|
||||||
overview_object_versioning
|
|
||||||
overview_global_cluster
|
overview_global_cluster
|
||||||
overview_container_sync
|
overview_container_sync
|
||||||
overview_expiring_objects
|
overview_expiring_objects
|
||||||
|
@ -37,7 +37,7 @@ AWS S3 Api
|
|||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
.. automodule:: swift.common.middleware.s3api.etree
|
.. automodule:: swift.common.middleware.s3api.etree
|
||||||
:members:
|
:members: _Element
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
.. automodule:: swift.common.middleware.s3api.utils
|
.. automodule:: swift.common.middleware.s3api.utils
|
||||||
|
@ -1,5 +0,0 @@
|
|||||||
Object Versioning
|
|
||||||
=================
|
|
||||||
|
|
||||||
.. automodule:: swift.common.middleware.versioned_writes
|
|
||||||
:show-inheritance:
|
|
@ -359,7 +359,8 @@ can't get perfect balance due to too many partitions recently moved).
|
|||||||
---------------
|
---------------
|
||||||
Composite Rings
|
Composite Rings
|
||||||
---------------
|
---------------
|
||||||
.. automodule:: swift.common.ring.composite_builder
|
|
||||||
|
See :ref:`composite_builder`.
|
||||||
|
|
||||||
**********************************
|
**********************************
|
||||||
swift-ring-composer (Experimental)
|
swift-ring-composer (Experimental)
|
||||||
|
@ -24,6 +24,8 @@ Ring Builder
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
.. _composite_builder:
|
||||||
|
|
||||||
Composite Ring Builder
|
Composite Ring Builder
|
||||||
======================
|
======================
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user