Merge "fix doc title format error"
This commit is contained in:
@@ -27,7 +27,7 @@ Pull requests submitted through GitHub will be ignored.
|
|||||||
.. _DeveloperWorkflow: https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
.. _DeveloperWorkflow: https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||||
|
|
||||||
Project Hosting Details
|
Project Hosting Details
|
||||||
-------------------------
|
-----------------------
|
||||||
|
|
||||||
Project Documentation
|
Project Documentation
|
||||||
https://docs.openstack.org/python-openstacksdk/latest/
|
https://docs.openstack.org/python-openstacksdk/latest/
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
Tasks Needed for rationalizing shade and openstacksdk
|
Tasks Needed for rationalizing shade and openstacksdk
|
||||||
======================================================
|
=====================================================
|
||||||
|
|
||||||
A large portion of the important things have already been done and landed
|
A large portion of the important things have already been done and landed
|
||||||
already. For reference, those are:
|
already. For reference, those are:
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
.. _openstack-config:
|
.. _openstack-config:
|
||||||
|
|
||||||
========================================
|
======================================
|
||||||
Configuring OpenStack SDK Applications
|
Configuring OpenStack SDK Applications
|
||||||
========================================
|
======================================
|
||||||
|
|
||||||
.. _config-environment-variables:
|
.. _config-environment-variables:
|
||||||
|
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
========================
|
======================
|
||||||
Using os-client-config
|
Using os-client-config
|
||||||
========================
|
======================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
Using OpenStack Baremetal
|
Using OpenStack Baremetal
|
||||||
===========================
|
=========================
|
||||||
|
|
||||||
Before working with the Baremetal service, you'll need to create a
|
Before working with the Baremetal service, you'll need to create a
|
||||||
connection to your OpenStack cloud by following the :doc:`connect` user
|
connection to your OpenStack cloud by following the :doc:`connect` user
|
||||||
|
@@ -12,9 +12,9 @@
|
|||||||
under the License.
|
under the License.
|
||||||
|
|
||||||
|
|
||||||
================================
|
==========================
|
||||||
Using OpenStack Clustering
|
Using OpenStack Clustering
|
||||||
================================
|
==========================
|
||||||
|
|
||||||
Before working with the Clustering service, you'll need to create a
|
Before working with the Clustering service, you'll need to create a
|
||||||
connection to your OpenStack cloud by following the :doc:`connect` user guide.
|
connection to your OpenStack cloud by following the :doc:`connect` user guide.
|
||||||
|
@@ -22,7 +22,7 @@ policies.
|
|||||||
|
|
||||||
|
|
||||||
List Events
|
List Events
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
To examine the list of events:
|
To examine the list of events:
|
||||||
|
|
||||||
|
@@ -66,7 +66,7 @@ Full example: `manage profile`_
|
|||||||
|
|
||||||
|
|
||||||
Get Profile
|
Get Profile
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
To get a profile based on its name or ID:
|
To get a profile based on its name or ID:
|
||||||
|
|
||||||
|
@@ -1,12 +1,12 @@
|
|||||||
Baremetal API
|
Baremetal API
|
||||||
==============
|
=============
|
||||||
|
|
||||||
For details on how to use baremetal, see :doc:`/user/guides/baremetal`
|
For details on how to use baremetal, see :doc:`/user/guides/baremetal`
|
||||||
|
|
||||||
.. automodule:: openstack.baremetal.v1._proxy
|
.. automodule:: openstack.baremetal.v1._proxy
|
||||||
|
|
||||||
The Baremetal Class
|
The Baremetal Class
|
||||||
--------------------
|
-------------------
|
||||||
|
|
||||||
The baremetal high-level interface is available through the ``baremetal``
|
The baremetal high-level interface is available through the ``baremetal``
|
||||||
member of a :class:`~openstack.connection.Connection` object.
|
member of a :class:`~openstack.connection.Connection` object.
|
||||||
|
@@ -43,7 +43,7 @@ Snapshot Operations
|
|||||||
.. automethod:: openstack.block_storage.v2._proxy.Proxy.snapshots
|
.. automethod:: openstack.block_storage.v2._proxy.Proxy.snapshots
|
||||||
|
|
||||||
Stats Operations
|
Stats Operations
|
||||||
^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
.. autoclass:: openstack.block_storage.v2._proxy.Proxy
|
.. autoclass:: openstack.block_storage.v2._proxy.Proxy
|
||||||
|
|
||||||
|
@@ -170,7 +170,7 @@ Helper Operations
|
|||||||
|
|
||||||
|
|
||||||
Service Operations
|
Service Operations
|
||||||
^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
.. autoclass:: openstack.clustering.v1._proxy.Proxy
|
.. autoclass:: openstack.clustering.v1._proxy.Proxy
|
||||||
|
|
||||||
|
@@ -83,7 +83,7 @@ L7 Policy Operations
|
|||||||
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_l7_policy
|
.. automethod:: openstack.load_balancer.v2._proxy.Proxy.update_l7_policy
|
||||||
|
|
||||||
L7 Rule Operations
|
L7 Rule Operations
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
|
.. autoclass:: openstack.load_balancer.v2._proxy.Proxy
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
Baremetal Resources
|
Baremetal Resources
|
||||||
=====================
|
===================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
openstack.baremetal.v1.chassis
|
openstack.baremetal.v1.chassis
|
||||||
===============================
|
==============================
|
||||||
|
|
||||||
.. automodule:: openstack.baremetal.v1.chassis
|
.. automodule:: openstack.baremetal.v1.chassis
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
openstack.baremetal.v1.driver
|
openstack.baremetal.v1.driver
|
||||||
==============================
|
=============================
|
||||||
|
|
||||||
.. automodule:: openstack.baremetal.v1.driver
|
.. automodule:: openstack.baremetal.v1.driver
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
openstack.baremetal.v1.Node
|
openstack.baremetal.v1.Node
|
||||||
============================
|
===========================
|
||||||
|
|
||||||
.. automodule:: openstack.baremetal.v1.node
|
.. automodule:: openstack.baremetal.v1.node
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
openstack.baremetal.v1.port
|
openstack.baremetal.v1.port
|
||||||
============================
|
===========================
|
||||||
|
|
||||||
.. automodule:: openstack.baremetal.v1.port
|
.. automodule:: openstack.baremetal.v1.port
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
openstack.baremetal.v1.port_group
|
openstack.baremetal.v1.port_group
|
||||||
==================================
|
=================================
|
||||||
|
|
||||||
.. automodule:: openstack.baremetal.v1.port_group
|
.. automodule:: openstack.baremetal.v1.port_group
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
openstack.clustering.v1.Cluster
|
openstack.clustering.v1.Cluster
|
||||||
=====================================
|
===============================
|
||||||
|
|
||||||
.. automodule:: openstack.clustering.v1.cluster
|
.. automodule:: openstack.clustering.v1.cluster
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
openstack.compute.v2.flavor
|
openstack.compute.v2.flavor
|
||||||
============================
|
===========================
|
||||||
|
|
||||||
.. automodule:: openstack.compute.v2.flavor
|
.. automodule:: openstack.compute.v2.flavor
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
openstack.compute.v2.server
|
openstack.compute.v2.server
|
||||||
============================
|
===========================
|
||||||
|
|
||||||
.. automodule:: openstack.compute.v2.server
|
.. automodule:: openstack.compute.v2.server
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
Database Resources
|
Database Resources
|
||||||
======================
|
==================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
openstack.key_manager.v1.container
|
openstack.key_manager.v1.container
|
||||||
=====================================
|
==================================
|
||||||
|
|
||||||
.. automodule:: openstack.key_manager.v1.container
|
.. automodule:: openstack.key_manager.v1.container
|
||||||
|
|
||||||
|
@@ -1,10 +1,10 @@
|
|||||||
openstack.load_balancer.v2.l7_rule
|
openstack.load_balancer.v2.l7_rule
|
||||||
====================================
|
==================================
|
||||||
|
|
||||||
.. automodule:: openstack.load_balancer.v2.l7_rule
|
.. automodule:: openstack.load_balancer.v2.l7_rule
|
||||||
|
|
||||||
The L7Rule Class
|
The L7Rule Class
|
||||||
------------------
|
----------------
|
||||||
|
|
||||||
The ``L7Rule`` class inherits from :class:`~openstack.resource.Resource`.
|
The ``L7Rule`` class inherits from :class:`~openstack.resource.Resource`.
|
||||||
|
|
||||||
|
@@ -4,7 +4,7 @@ openstack.load_balancer.v2.pool
|
|||||||
.. automodule:: openstack.load_balancer.v2.pool
|
.. automodule:: openstack.load_balancer.v2.pool
|
||||||
|
|
||||||
The Pool Class
|
The Pool Class
|
||||||
------------------
|
--------------
|
||||||
|
|
||||||
The ``Pool`` class inherits from :class:`~openstack.resource.Resource`.
|
The ``Pool`` class inherits from :class:`~openstack.resource.Resource`.
|
||||||
|
|
||||||
|
@@ -4,7 +4,7 @@ openstack.network.v2.agent
|
|||||||
.. automodule:: openstack.network.v2.agent
|
.. automodule:: openstack.network.v2.agent
|
||||||
|
|
||||||
The Agent Class
|
The Agent Class
|
||||||
-----------------
|
---------------
|
||||||
|
|
||||||
The ``Agent`` class inherits from :class:`~openstack.resource.Resource`.
|
The ``Agent`` class inherits from :class:`~openstack.resource.Resource`.
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
ServiceFilter
|
ServiceFilter
|
||||||
==============
|
=============
|
||||||
.. automodule:: openstack.service_filter
|
.. automodule:: openstack.service_filter
|
||||||
|
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user