From 5d3d9de9ce371edd9e82b54d8f37af90e0121e4b Mon Sep 17 00:00:00 2001 From: "Yuanbin.Chen" Date: Fri, 23 Mar 2018 21:38:40 +0800 Subject: [PATCH] fix doc title format error This patch fixes the file title format inconsistent. Change-Id: I6ffff6f006cfb5c9b6663713acc55e2b2e30c28a Signed-off-by: Yuanbin.Chen --- CONTRIBUTING.rst | 2 +- SHADE-MERGE-TODO.rst | 2 +- doc/source/user/config/configuration.rst | 6 +++--- doc/source/user/config/index.rst | 6 +++--- doc/source/user/guides/baremetal.rst | 2 +- doc/source/user/guides/clustering.rst | 4 ++-- doc/source/user/guides/clustering/event.rst | 2 +- doc/source/user/guides/clustering/profile.rst | 2 +- doc/source/user/proxies/baremetal.rst | 4 ++-- doc/source/user/proxies/block_storage.rst | 2 +- doc/source/user/proxies/clustering.rst | 2 +- doc/source/user/proxies/load_balancer_v2.rst | 2 +- doc/source/user/resources/baremetal/index.rst | 2 +- doc/source/user/resources/baremetal/v1/chassis.rst | 2 +- doc/source/user/resources/baremetal/v1/driver.rst | 2 +- doc/source/user/resources/baremetal/v1/node.rst | 2 +- doc/source/user/resources/baremetal/v1/port.rst | 2 +- doc/source/user/resources/baremetal/v1/port_group.rst | 2 +- doc/source/user/resources/clustering/v1/cluster.rst | 2 +- doc/source/user/resources/compute/v2/flavor.rst | 2 +- doc/source/user/resources/compute/v2/server.rst | 2 +- doc/source/user/resources/database/index.rst | 2 +- doc/source/user/resources/key_manager/v1/container.rst | 2 +- doc/source/user/resources/load_balancer/v2/l7_rule.rst | 4 ++-- doc/source/user/resources/load_balancer/v2/pool.rst | 2 +- doc/source/user/resources/network/v2/agent.rst | 2 +- doc/source/user/service_filter.rst | 2 +- 27 files changed, 34 insertions(+), 34 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 9457276b9..d21643559 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -27,7 +27,7 @@ Pull requests submitted through GitHub will be ignored. .. _DeveloperWorkflow: https://docs.openstack.org/infra/manual/developers.html#development-workflow Project Hosting Details -------------------------- +----------------------- Project Documentation https://docs.openstack.org/python-openstacksdk/latest/ diff --git a/SHADE-MERGE-TODO.rst b/SHADE-MERGE-TODO.rst index 71be13eaa..baf684be0 100644 --- a/SHADE-MERGE-TODO.rst +++ b/SHADE-MERGE-TODO.rst @@ -1,5 +1,5 @@ Tasks Needed for rationalizing shade and openstacksdk -====================================================== +===================================================== A large portion of the important things have already been done and landed already. For reference, those are: diff --git a/doc/source/user/config/configuration.rst b/doc/source/user/config/configuration.rst index 19460c8dc..dc3b9000b 100644 --- a/doc/source/user/config/configuration.rst +++ b/doc/source/user/config/configuration.rst @@ -1,8 +1,8 @@ .. _openstack-config: -======================================== - Configuring OpenStack SDK Applications -======================================== +====================================== +Configuring OpenStack SDK Applications +====================================== .. _config-environment-variables: diff --git a/doc/source/user/config/index.rst b/doc/source/user/config/index.rst index d09b28351..11637239d 100644 --- a/doc/source/user/config/index.rst +++ b/doc/source/user/config/index.rst @@ -1,6 +1,6 @@ -======================== - Using os-client-config -======================== +====================== +Using os-client-config +====================== .. toctree:: :maxdepth: 2 diff --git a/doc/source/user/guides/baremetal.rst b/doc/source/user/guides/baremetal.rst index 81421ea99..9af1a86d2 100644 --- a/doc/source/user/guides/baremetal.rst +++ b/doc/source/user/guides/baremetal.rst @@ -1,5 +1,5 @@ Using OpenStack Baremetal -=========================== +========================= Before working with the Baremetal service, you'll need to create a connection to your OpenStack cloud by following the :doc:`connect` user diff --git a/doc/source/user/guides/clustering.rst b/doc/source/user/guides/clustering.rst index c0543fd5b..af56db52c 100644 --- a/doc/source/user/guides/clustering.rst +++ b/doc/source/user/guides/clustering.rst @@ -12,9 +12,9 @@ under the License. -================================ +========================== Using OpenStack Clustering -================================ +========================== Before working with the Clustering service, you'll need to create a connection to your OpenStack cloud by following the :doc:`connect` user guide. diff --git a/doc/source/user/guides/clustering/event.rst b/doc/source/user/guides/clustering/event.rst index 5969ec323..753208045 100644 --- a/doc/source/user/guides/clustering/event.rst +++ b/doc/source/user/guides/clustering/event.rst @@ -22,7 +22,7 @@ policies. List Events -~~~~~~~~~~~~ +~~~~~~~~~~~ To examine the list of events: diff --git a/doc/source/user/guides/clustering/profile.rst b/doc/source/user/guides/clustering/profile.rst index 1c8d7f96a..dc7e2ed72 100644 --- a/doc/source/user/guides/clustering/profile.rst +++ b/doc/source/user/guides/clustering/profile.rst @@ -66,7 +66,7 @@ Full example: `manage profile`_ Get Profile -~~~~~~~~~~~~ +~~~~~~~~~~~ To get a profile based on its name or ID: diff --git a/doc/source/user/proxies/baremetal.rst b/doc/source/user/proxies/baremetal.rst index b10f38b63..f3772bb8b 100644 --- a/doc/source/user/proxies/baremetal.rst +++ b/doc/source/user/proxies/baremetal.rst @@ -1,12 +1,12 @@ Baremetal API -============== +============= For details on how to use baremetal, see :doc:`/user/guides/baremetal` .. automodule:: openstack.baremetal.v1._proxy The Baremetal Class --------------------- +------------------- The baremetal high-level interface is available through the ``baremetal`` member of a :class:`~openstack.connection.Connection` object. diff --git a/doc/source/user/proxies/block_storage.rst b/doc/source/user/proxies/block_storage.rst index 8395709c3..cd4e79204 100644 --- a/doc/source/user/proxies/block_storage.rst +++ b/doc/source/user/proxies/block_storage.rst @@ -43,7 +43,7 @@ Snapshot Operations .. automethod:: openstack.block_storage.v2._proxy.Proxy.snapshots Stats Operations -^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^ .. autoclass:: openstack.block_storage.v2._proxy.Proxy diff --git a/doc/source/user/proxies/clustering.rst b/doc/source/user/proxies/clustering.rst index ff8b5c380..2c0d56e83 100644 --- a/doc/source/user/proxies/clustering.rst +++ b/doc/source/user/proxies/clustering.rst @@ -170,7 +170,7 @@ Helper Operations Service Operations -^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ .. autoclass:: openstack.clustering.v1._proxy.Proxy diff --git a/doc/source/user/proxies/load_balancer_v2.rst b/doc/source/user/proxies/load_balancer_v2.rst index 4ff99ffef..0ad940691 100644 --- a/doc/source/user/proxies/load_balancer_v2.rst +++ b/doc/source/user/proxies/load_balancer_v2.rst @@ -83,7 +83,7 @@ L7 Policy Operations .. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_l7_policy L7 Rule Operations -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^ .. autoclass:: openstack.load_balancer.v2._proxy.Proxy diff --git a/doc/source/user/resources/baremetal/index.rst b/doc/source/user/resources/baremetal/index.rst index c8025248b..123fc5e4a 100644 --- a/doc/source/user/resources/baremetal/index.rst +++ b/doc/source/user/resources/baremetal/index.rst @@ -1,5 +1,5 @@ Baremetal Resources -===================== +=================== .. toctree:: :maxdepth: 1 diff --git a/doc/source/user/resources/baremetal/v1/chassis.rst b/doc/source/user/resources/baremetal/v1/chassis.rst index 8db33407a..87a606389 100644 --- a/doc/source/user/resources/baremetal/v1/chassis.rst +++ b/doc/source/user/resources/baremetal/v1/chassis.rst @@ -1,5 +1,5 @@ openstack.baremetal.v1.chassis -=============================== +============================== .. automodule:: openstack.baremetal.v1.chassis diff --git a/doc/source/user/resources/baremetal/v1/driver.rst b/doc/source/user/resources/baremetal/v1/driver.rst index 980a067bc..f987d0861 100644 --- a/doc/source/user/resources/baremetal/v1/driver.rst +++ b/doc/source/user/resources/baremetal/v1/driver.rst @@ -1,5 +1,5 @@ openstack.baremetal.v1.driver -============================== +============================= .. automodule:: openstack.baremetal.v1.driver diff --git a/doc/source/user/resources/baremetal/v1/node.rst b/doc/source/user/resources/baremetal/v1/node.rst index 323c8db6e..37d563f7d 100644 --- a/doc/source/user/resources/baremetal/v1/node.rst +++ b/doc/source/user/resources/baremetal/v1/node.rst @@ -1,5 +1,5 @@ openstack.baremetal.v1.Node -============================ +=========================== .. automodule:: openstack.baremetal.v1.node diff --git a/doc/source/user/resources/baremetal/v1/port.rst b/doc/source/user/resources/baremetal/v1/port.rst index 34f1ab9a3..2bf0e1865 100644 --- a/doc/source/user/resources/baremetal/v1/port.rst +++ b/doc/source/user/resources/baremetal/v1/port.rst @@ -1,5 +1,5 @@ openstack.baremetal.v1.port -============================ +=========================== .. automodule:: openstack.baremetal.v1.port diff --git a/doc/source/user/resources/baremetal/v1/port_group.rst b/doc/source/user/resources/baremetal/v1/port_group.rst index 8867dc16d..45c2bd91a 100644 --- a/doc/source/user/resources/baremetal/v1/port_group.rst +++ b/doc/source/user/resources/baremetal/v1/port_group.rst @@ -1,5 +1,5 @@ openstack.baremetal.v1.port_group -================================== +================================= .. automodule:: openstack.baremetal.v1.port_group diff --git a/doc/source/user/resources/clustering/v1/cluster.rst b/doc/source/user/resources/clustering/v1/cluster.rst index 43e8a6d51..779c7d6ce 100644 --- a/doc/source/user/resources/clustering/v1/cluster.rst +++ b/doc/source/user/resources/clustering/v1/cluster.rst @@ -1,5 +1,5 @@ openstack.clustering.v1.Cluster -===================================== +=============================== .. automodule:: openstack.clustering.v1.cluster diff --git a/doc/source/user/resources/compute/v2/flavor.rst b/doc/source/user/resources/compute/v2/flavor.rst index 9f62f96f2..45fee1b1e 100644 --- a/doc/source/user/resources/compute/v2/flavor.rst +++ b/doc/source/user/resources/compute/v2/flavor.rst @@ -1,5 +1,5 @@ openstack.compute.v2.flavor -============================ +=========================== .. automodule:: openstack.compute.v2.flavor diff --git a/doc/source/user/resources/compute/v2/server.rst b/doc/source/user/resources/compute/v2/server.rst index 6f0ddbb7d..5dc072c75 100644 --- a/doc/source/user/resources/compute/v2/server.rst +++ b/doc/source/user/resources/compute/v2/server.rst @@ -1,5 +1,5 @@ openstack.compute.v2.server -============================ +=========================== .. automodule:: openstack.compute.v2.server diff --git a/doc/source/user/resources/database/index.rst b/doc/source/user/resources/database/index.rst index 962aa081d..3218b40a7 100644 --- a/doc/source/user/resources/database/index.rst +++ b/doc/source/user/resources/database/index.rst @@ -1,5 +1,5 @@ Database Resources -====================== +================== .. toctree:: :maxdepth: 1 diff --git a/doc/source/user/resources/key_manager/v1/container.rst b/doc/source/user/resources/key_manager/v1/container.rst index ef09035dc..601e7b181 100644 --- a/doc/source/user/resources/key_manager/v1/container.rst +++ b/doc/source/user/resources/key_manager/v1/container.rst @@ -1,5 +1,5 @@ openstack.key_manager.v1.container -===================================== +================================== .. automodule:: openstack.key_manager.v1.container diff --git a/doc/source/user/resources/load_balancer/v2/l7_rule.rst b/doc/source/user/resources/load_balancer/v2/l7_rule.rst index 2b1f471af..c661cd676 100644 --- a/doc/source/user/resources/load_balancer/v2/l7_rule.rst +++ b/doc/source/user/resources/load_balancer/v2/l7_rule.rst @@ -1,10 +1,10 @@ openstack.load_balancer.v2.l7_rule -==================================== +================================== .. automodule:: openstack.load_balancer.v2.l7_rule The L7Rule Class ------------------- +---------------- The ``L7Rule`` class inherits from :class:`~openstack.resource.Resource`. diff --git a/doc/source/user/resources/load_balancer/v2/pool.rst b/doc/source/user/resources/load_balancer/v2/pool.rst index 19c04e3f1..e67f97c29 100644 --- a/doc/source/user/resources/load_balancer/v2/pool.rst +++ b/doc/source/user/resources/load_balancer/v2/pool.rst @@ -4,7 +4,7 @@ openstack.load_balancer.v2.pool .. automodule:: openstack.load_balancer.v2.pool The Pool Class ------------------- +-------------- The ``Pool`` class inherits from :class:`~openstack.resource.Resource`. diff --git a/doc/source/user/resources/network/v2/agent.rst b/doc/source/user/resources/network/v2/agent.rst index 1d99337dc..5593e6d94 100644 --- a/doc/source/user/resources/network/v2/agent.rst +++ b/doc/source/user/resources/network/v2/agent.rst @@ -4,7 +4,7 @@ openstack.network.v2.agent .. automodule:: openstack.network.v2.agent The Agent Class ------------------ +--------------- The ``Agent`` class inherits from :class:`~openstack.resource.Resource`. diff --git a/doc/source/user/service_filter.rst b/doc/source/user/service_filter.rst index 60910ce6e..a58177f25 100644 --- a/doc/source/user/service_filter.rst +++ b/doc/source/user/service_filter.rst @@ -1,5 +1,5 @@ ServiceFilter -============== +============= .. automodule:: openstack.service_filter